_ Git - rust-lightning/blob - lightning/src/ln/functional_tests.rs

   1 //! Tests that test standing up a network of ChannelManagers, creating channels, sending
   2 //! payments/messages between them, and often checking the resulting ChannelMonitors are able to
   3 //! claim outputs on-chain.
   4
   5 use chain::transaction::OutPoint;
   6 use chain::keysinterface::{ChannelKeys, KeysInterface, SpendableOutputDescriptor};
   7 use chain::chaininterface;
   8 use chain::chaininterface::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
   9 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  10 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  11 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
  12 use ln::channelmonitor;
  13 use ln::channel::{Channel, ChannelError};
  14 use ln::{chan_utils, onion_utils};
  15 use routing::router::{Route, RouteHop, get_route};
  16 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  17 use ln::msgs;
  18 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction, OptionalField};
  19 use util::enforcing_trait_impls::EnforcingChannelKeys;
  20 use util::{byte_utils, test_utils};
  21 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  22 use util::errors::APIError;
  23 use util::ser::{Writeable, Writer, ReadableArgs, Readable};
  24 use util::config::UserConfig;
  25
  26 use bitcoin::util::hash::BitcoinHash;
  27 use bitcoin::hashes::sha256d::Hash as Sha256dHash;
  28 use bitcoin::hashes::HashEngine;
  29 use bitcoin::hash_types::{Txid, BlockHash, WPubkeyHash};
  30 use bitcoin::util::bip143;
  31 use bitcoin::util::address::Address;
  32 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  33 use bitcoin::blockdata::block::{Block, BlockHeader};
  34 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  35 use bitcoin::blockdata::script::{Builder, Script};
  36 use bitcoin::blockdata::opcodes;
  37 use bitcoin::blockdata::constants::genesis_block;
  38 use bitcoin::network::constants::Network;
  39
  40 use bitcoin::hashes::sha256::Hash as Sha256;
  41 use bitcoin::hashes::Hash;
  42
  43 use bitcoin::secp256k1::{Secp256k1, Message};
  44 use bitcoin::secp256k1::key::{PublicKey,SecretKey};
  45
  46 use regex;
  47
  48 use std::collections::{BTreeSet, HashMap, HashSet};
  49 use std::default::Default;
  50 use std::sync::{Arc, Mutex};
  51 use std::sync::atomic::Ordering;
  52 use std::{mem, io};
  53
  54 use ln::functional_test_utils::*;
  55
  56 #[test]
  57 fn test_insane_channel_opens() {
  58         // Stand up a network of 2 nodes
  59         let chanmon_cfgs = create_chanmon_cfgs(2);
  60         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  61         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  62         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  63
  64         // Instantiate channel parameters where we push the maximum msats given our
  65         // funding satoshis
  66         let channel_value_sat = 31337; // same as funding satoshis
  67         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_remote_channel_reserve_satoshis(channel_value_sat);
  68         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  69
  70         // Have node0 initiate a channel to node1 with aforementioned parameters
  71         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  72
  73         // Extract the channel open message from node0 to node1
  74         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  75
  76         // Test helper that asserts we get the correct error string given a mutator
  77         // that supposedly makes the channel open message insane
  78         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  79                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &message_mutator(open_channel_message.clone()));
  80                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  81                 assert_eq!(msg_events.len(), 1);
  82                 let expected_regex = regex::Regex::new(expected_error_str).unwrap();
  83                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  84                         match action {
  85                                 &ErrorAction::SendErrorMessage { .. } => {
  86                                         nodes[1].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), expected_regex, 1);
  87                                 },
  88                                 _ => panic!("unexpected event!"),
  89                         }
  90                 } else { assert!(false); }
  91         };
  92
  93         use ln::channel::MAX_FUNDING_SATOSHIS;
  94         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  95
  96         // Test all mutations that would make the channel open message insane
  97         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 });
  98
  99         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
 100
 101         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 });
 102
 103         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 104
 105         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 });
 106
 107         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 });
 108
 109         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 });
 110
 111         insane_open_helper("0 max_accepted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 112
 113         insane_open_helper("max_accepted_htlcs was 484. It must not be larger than 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 114 }
 115
 116 #[test]
 117 fn test_async_inbound_update_fee() {
 118         let chanmon_cfgs = create_chanmon_cfgs(2);
 119         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 120         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 121         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 122         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 123         let logger = test_utils::TestLogger::new();
 124         let channel_id = chan.2;
 125
 126         // balancing
 127         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 128
 129         // A                                        B
 130         // update_fee                            ->
 131         // send (1) commitment_signed            -.
 132         //                                       <- update_add_htlc/commitment_signed
 133         // send (2) RAA (awaiting remote revoke) -.
 134         // (1) commitment_signed is delivered    ->
 135         //                                       .- send (3) RAA (awaiting remote revoke)
 136         // (2) RAA is delivered                  ->
 137         //                                       .- send (4) commitment_signed
 138         //                                       <- (3) RAA is delivered
 139         // send (5) commitment_signed            -.
 140         //                                       <- (4) commitment_signed is delivered
 141         // send (6) RAA                          -.
 142         // (5) commitment_signed is delivered    ->
 143         //                                       <- RAA
 144         // (6) RAA is delivered                  ->
 145
 146         // First nodes[0] generates an update_fee
 147         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 148         check_added_monitors!(nodes[0], 1);
 149
 150         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 151         assert_eq!(events_0.len(), 1);
 152         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 153                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 154                         (update_fee.as_ref(), commitment_signed)
 155                 },
 156                 _ => panic!("Unexpected event"),
 157         };
 158
 159         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 160
 161         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 162         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 163         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 164         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();
 165         check_added_monitors!(nodes[1], 1);
 166
 167         let payment_event = {
 168                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 169                 assert_eq!(events_1.len(), 1);
 170                 SendEvent::from_event(events_1.remove(0))
 171         };
 172         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 173         assert_eq!(payment_event.msgs.len(), 1);
 174
 175         // ...now when the messages get delivered everyone should be happy
 176         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 177         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 178         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 179         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 180         check_added_monitors!(nodes[0], 1);
 181
 182         // deliver(1), generate (3):
 183         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 184         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 185         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 186         check_added_monitors!(nodes[1], 1);
 187
 188         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 189         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 190         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 191         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 192         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 193         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 194         assert!(bs_update.update_fee.is_none()); // (4)
 195         check_added_monitors!(nodes[1], 1);
 196
 197         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 198         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 199         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 200         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 201         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 202         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 203         assert!(as_update.update_fee.is_none()); // (5)
 204         check_added_monitors!(nodes[0], 1);
 205
 206         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 207         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 208         // only (6) so get_event_msg's assert(len == 1) passes
 209         check_added_monitors!(nodes[0], 1);
 210
 211         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 212         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 213         check_added_monitors!(nodes[1], 1);
 214
 215         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 216         check_added_monitors!(nodes[0], 1);
 217
 218         let events_2 = nodes[0].node.get_and_clear_pending_events();
 219         assert_eq!(events_2.len(), 1);
 220         match events_2[0] {
 221                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 222                 _ => panic!("Unexpected event"),
 223         }
 224
 225         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 226         check_added_monitors!(nodes[1], 1);
 227 }
 228
 229 #[test]
 230 fn test_update_fee_unordered_raa() {
 231         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 232         // crash in an earlier version of the update_fee patch)
 233         let chanmon_cfgs = create_chanmon_cfgs(2);
 234         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 235         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 236         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 237         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 238         let channel_id = chan.2;
 239         let logger = test_utils::TestLogger::new();
 240
 241         // balancing
 242         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 243
 244         // First nodes[0] generates an update_fee
 245         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 246         check_added_monitors!(nodes[0], 1);
 247
 248         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 249         assert_eq!(events_0.len(), 1);
 250         let update_msg = match events_0[0] { // (1)
 251                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 252                         update_fee.as_ref()
 253                 },
 254                 _ => panic!("Unexpected event"),
 255         };
 256
 257         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 258
 259         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 260         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 261         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 262         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();
 263         check_added_monitors!(nodes[1], 1);
 264
 265         let payment_event = {
 266                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 267                 assert_eq!(events_1.len(), 1);
 268                 SendEvent::from_event(events_1.remove(0))
 269         };
 270         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 271         assert_eq!(payment_event.msgs.len(), 1);
 272
 273         // ...now when the messages get delivered everyone should be happy
 274         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 275         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 276         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 277         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 278         check_added_monitors!(nodes[0], 1);
 279
 280         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 281         check_added_monitors!(nodes[1], 1);
 282
 283         // We can't continue, sadly, because our (1) now has a bogus signature
 284 }
 285
 286 #[test]
 287 fn test_multi_flight_update_fee() {
 288         let chanmon_cfgs = create_chanmon_cfgs(2);
 289         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 290         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 291         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 292         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 293         let channel_id = chan.2;
 294
 295         // A                                        B
 296         // update_fee/commitment_signed          ->
 297         //                                       .- send (1) RAA and (2) commitment_signed
 298         // update_fee (never committed)          ->
 299         // (3) update_fee                        ->
 300         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 301         // don't track which updates correspond to which revoke_and_ack responses so we're in
 302         // AwaitingRAA mode and will not generate the update_fee yet.
 303         //                                       <- (1) RAA delivered
 304         // (3) is generated and send (4) CS      -.
 305         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 306         // know the per_commitment_point to use for it.
 307         //                                       <- (2) commitment_signed delivered
 308         // revoke_and_ack                        ->
 309         //                                          B should send no response here
 310         // (4) commitment_signed delivered       ->
 311         //                                       <- RAA/commitment_signed delivered
 312         // revoke_and_ack                        ->
 313
 314         // First nodes[0] generates an update_fee
 315         let initial_feerate = get_feerate!(nodes[0], channel_id);
 316         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 317         check_added_monitors!(nodes[0], 1);
 318
 319         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 320         assert_eq!(events_0.len(), 1);
 321         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 322                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 323                         (update_fee.as_ref().unwrap(), commitment_signed)
 324                 },
 325                 _ => panic!("Unexpected event"),
 326         };
 327
 328         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 329         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 330         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 331         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 332         check_added_monitors!(nodes[1], 1);
 333
 334         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 335         // transaction:
 336         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 337         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 338         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 339
 340         // Create the (3) update_fee message that nodes[0] will generate before it does...
 341         let mut update_msg_2 = msgs::UpdateFee {
 342                 channel_id: update_msg_1.channel_id.clone(),
 343                 feerate_per_kw: (initial_feerate + 30) as u32,
 344         };
 345
 346         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 347
 348         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 349         // Deliver (3)
 350         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 351
 352         // Deliver (1), generating (3) and (4)
 353         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 354         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 355         check_added_monitors!(nodes[0], 1);
 356         assert!(as_second_update.update_add_htlcs.is_empty());
 357         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 358         assert!(as_second_update.update_fail_htlcs.is_empty());
 359         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 360         // Check that the update_fee newly generated matches what we delivered:
 361         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 362         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 363
 364         // Deliver (2) commitment_signed
 365         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 366         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 367         check_added_monitors!(nodes[0], 1);
 368         // No commitment_signed so get_event_msg's assert(len == 1) passes
 369
 370         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 371         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 372         check_added_monitors!(nodes[1], 1);
 373
 374         // Delever (4)
 375         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 376         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 377         check_added_monitors!(nodes[1], 1);
 378
 379         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 380         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 381         check_added_monitors!(nodes[0], 1);
 382
 383         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 384         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 385         // No commitment_signed so get_event_msg's assert(len == 1) passes
 386         check_added_monitors!(nodes[0], 1);
 387
 388         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 389         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 390         check_added_monitors!(nodes[1], 1);
 391 }
 392
 393 #[test]
 394 fn test_1_conf_open() {
 395         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 396         // tests that we properly send one in that case.
 397         let mut alice_config = UserConfig::default();
 398         alice_config.own_channel_config.minimum_depth = 1;
 399         alice_config.channel_options.announced_channel = true;
 400         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 401         let mut bob_config = UserConfig::default();
 402         bob_config.own_channel_config.minimum_depth = 1;
 403         bob_config.channel_options.announced_channel = true;
 404         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 405         let chanmon_cfgs = create_chanmon_cfgs(2);
 406         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 407         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 408         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 409
 410         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
 411         assert!(nodes[0].chain_monitor.does_match_tx(&tx));
 412         assert!(nodes[1].chain_monitor.does_match_tx(&tx));
 413
 414         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 415         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version as usize; 1]);
 416         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()));
 417
 418         nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version as usize; 1]);
 419         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 420         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 421
 422         for node in nodes {
 423                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 424                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 425                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 426         }
 427 }
 428
 429 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 430         // Previously, we had issues deserializing channels when we hadn't connected the first block
 431         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 432         // serialization round-trips and simply do steps towards opening a channel and then drop the
 433         // Node objects.
 434
 435         let chanmon_cfgs = create_chanmon_cfgs(2);
 436         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 437         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 438         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 439
 440         if steps & 0b1000_0000 != 0{
 441                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 442                 nodes[0].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 443                 nodes[1].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 444         }
 445
 446         if steps & 0x0f == 0 { return; }
 447         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 448         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 449
 450         if steps & 0x0f == 1 { return; }
 451         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 452         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 453
 454         if steps & 0x0f == 2 { return; }
 455         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 456
 457         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 458
 459         if steps & 0x0f == 3 { return; }
 460         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 461         check_added_monitors!(nodes[0], 0);
 462         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 463
 464         if steps & 0x0f == 4 { return; }
 465         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 466         {
 467                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
 468                 assert_eq!(added_monitors.len(), 1);
 469                 assert_eq!(added_monitors[0].0, funding_output);
 470                 added_monitors.clear();
 471         }
 472         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 473
 474         if steps & 0x0f == 5 { return; }
 475         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 476         {
 477                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 478                 assert_eq!(added_monitors.len(), 1);
 479                 assert_eq!(added_monitors[0].0, funding_output);
 480                 added_monitors.clear();
 481         }
 482
 483         let events_4 = nodes[0].node.get_and_clear_pending_events();
 484         assert_eq!(events_4.len(), 1);
 485         match events_4[0] {
 486                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 487                         assert_eq!(user_channel_id, 42);
 488                         assert_eq!(*funding_txo, funding_output);
 489                 },
 490                 _ => panic!("Unexpected event"),
 491         };
 492
 493         if steps & 0x0f == 6 { return; }
 494         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 495
 496         if steps & 0x0f == 7 { return; }
 497         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
 498         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 499 }
 500
 501 #[test]
 502 fn test_sanity_on_in_flight_opens() {
 503         do_test_sanity_on_in_flight_opens(0);
 504         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 505         do_test_sanity_on_in_flight_opens(1);
 506         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 507         do_test_sanity_on_in_flight_opens(2);
 508         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 509         do_test_sanity_on_in_flight_opens(3);
 510         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 511         do_test_sanity_on_in_flight_opens(4);
 512         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 513         do_test_sanity_on_in_flight_opens(5);
 514         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(6);
 516         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(7);
 518         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(8);
 520         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 521 }
 522
 523 #[test]
 524 fn test_update_fee_vanilla() {
 525         let chanmon_cfgs = create_chanmon_cfgs(2);
 526         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 527         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 528         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 529         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 530         let channel_id = chan.2;
 531
 532         let feerate = get_feerate!(nodes[0], channel_id);
 533         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 534         check_added_monitors!(nodes[0], 1);
 535
 536         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 537         assert_eq!(events_0.len(), 1);
 538         let (update_msg, commitment_signed) = match events_0[0] {
 539                         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 } } => {
 540                         (update_fee.as_ref(), commitment_signed)
 541                 },
 542                 _ => panic!("Unexpected event"),
 543         };
 544         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 545
 546         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 547         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 548         check_added_monitors!(nodes[1], 1);
 549
 550         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 551         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 552         check_added_monitors!(nodes[0], 1);
 553
 554         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 555         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 556         // No commitment_signed so get_event_msg's assert(len == 1) passes
 557         check_added_monitors!(nodes[0], 1);
 558
 559         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 560         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 561         check_added_monitors!(nodes[1], 1);
 562 }
 563
 564 #[test]
 565 fn test_update_fee_that_funder_cannot_afford() {
 566         let chanmon_cfgs = create_chanmon_cfgs(2);
 567         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 568         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 569         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 570         let channel_value = 1888;
 571         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 572         let channel_id = chan.2;
 573
 574         let feerate = 260;
 575         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 576         check_added_monitors!(nodes[0], 1);
 577         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 578
 579         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 580
 581         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 582
 583         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 584         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 585         {
 586                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 587
 588                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 589                 let num_htlcs = commitment_tx.output.len() - 2;
 590                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 591                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 592                 actual_fee = channel_value - actual_fee;
 593                 assert_eq!(total_fee, actual_fee);
 594         }
 595
 596         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 597         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 598         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 599         check_added_monitors!(nodes[0], 1);
 600
 601         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 602
 603         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 604
 605         //While producing the commitment_signed response after handling a received update_fee request the
 606         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 607         //Should produce and error.
 608         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 609         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 610         check_added_monitors!(nodes[1], 1);
 611         check_closed_broadcast!(nodes[1], true);
 612 }
 613
 614 #[test]
 615 fn test_update_fee_with_fundee_update_add_htlc() {
 616         let chanmon_cfgs = create_chanmon_cfgs(2);
 617         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 618         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 619         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 620         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 621         let channel_id = chan.2;
 622         let logger = test_utils::TestLogger::new();
 623
 624         // balancing
 625         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 626
 627         let feerate = get_feerate!(nodes[0], channel_id);
 628         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 629         check_added_monitors!(nodes[0], 1);
 630
 631         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 632         assert_eq!(events_0.len(), 1);
 633         let (update_msg, commitment_signed) = match events_0[0] {
 634                         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 } } => {
 635                         (update_fee.as_ref(), commitment_signed)
 636                 },
 637                 _ => panic!("Unexpected event"),
 638         };
 639         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 640         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 641         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 642         check_added_monitors!(nodes[1], 1);
 643
 644         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 645         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 646         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();
 647
 648         // nothing happens since node[1] is in AwaitingRemoteRevoke
 649         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
 650         {
 651                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 652                 assert_eq!(added_monitors.len(), 0);
 653                 added_monitors.clear();
 654         }
 655         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 656         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 657         // node[1] has nothing to do
 658
 659         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 660         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 661         check_added_monitors!(nodes[0], 1);
 662
 663         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 664         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 665         // No commitment_signed so get_event_msg's assert(len == 1) passes
 666         check_added_monitors!(nodes[0], 1);
 667         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 668         check_added_monitors!(nodes[1], 1);
 669         // AwaitingRemoteRevoke ends here
 670
 671         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 672         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 673         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 674         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 675         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 676         assert_eq!(commitment_update.update_fee.is_none(), true);
 677
 678         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 679         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 680         check_added_monitors!(nodes[0], 1);
 681         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 682
 683         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 684         check_added_monitors!(nodes[1], 1);
 685         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 686
 687         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 688         check_added_monitors!(nodes[1], 1);
 689         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 690         // No commitment_signed so get_event_msg's assert(len == 1) passes
 691
 692         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 693         check_added_monitors!(nodes[0], 1);
 694         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 695
 696         expect_pending_htlcs_forwardable!(nodes[0]);
 697
 698         let events = nodes[0].node.get_and_clear_pending_events();
 699         assert_eq!(events.len(), 1);
 700         match events[0] {
 701                 Event::PaymentReceived { .. } => { },
 702                 _ => panic!("Unexpected event"),
 703         };
 704
 705         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 706
 707         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 708         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 709         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 710 }
 711
 712 #[test]
 713 fn test_update_fee() {
 714         let chanmon_cfgs = create_chanmon_cfgs(2);
 715         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 716         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 717         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 718         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 719         let channel_id = chan.2;
 720
 721         // A                                        B
 722         // (1) update_fee/commitment_signed      ->
 723         //                                       <- (2) revoke_and_ack
 724         //                                       .- send (3) commitment_signed
 725         // (4) update_fee/commitment_signed      ->
 726         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 727         //                                       <- (3) commitment_signed delivered
 728         // send (6) revoke_and_ack               -.
 729         //                                       <- (5) deliver revoke_and_ack
 730         // (6) deliver revoke_and_ack            ->
 731         //                                       .- send (7) commitment_signed in response to (4)
 732         //                                       <- (7) deliver commitment_signed
 733         // revoke_and_ack                        ->
 734
 735         // Create and deliver (1)...
 736         let feerate = get_feerate!(nodes[0], channel_id);
 737         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 738         check_added_monitors!(nodes[0], 1);
 739
 740         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 741         assert_eq!(events_0.len(), 1);
 742         let (update_msg, commitment_signed) = match events_0[0] {
 743                         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 } } => {
 744                         (update_fee.as_ref(), commitment_signed)
 745                 },
 746                 _ => panic!("Unexpected event"),
 747         };
 748         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 749
 750         // Generate (2) and (3):
 751         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 752         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 753         check_added_monitors!(nodes[1], 1);
 754
 755         // Deliver (2):
 756         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 757         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 758         check_added_monitors!(nodes[0], 1);
 759
 760         // Create and deliver (4)...
 761         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 762         check_added_monitors!(nodes[0], 1);
 763         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 764         assert_eq!(events_0.len(), 1);
 765         let (update_msg, commitment_signed) = match events_0[0] {
 766                         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 } } => {
 767                         (update_fee.as_ref(), commitment_signed)
 768                 },
 769                 _ => panic!("Unexpected event"),
 770         };
 771
 772         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 773         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 774         check_added_monitors!(nodes[1], 1);
 775         // ... creating (5)
 776         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 777         // No commitment_signed so get_event_msg's assert(len == 1) passes
 778
 779         // Handle (3), creating (6):
 780         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 781         check_added_monitors!(nodes[0], 1);
 782         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 783         // No commitment_signed so get_event_msg's assert(len == 1) passes
 784
 785         // Deliver (5):
 786         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 787         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 788         check_added_monitors!(nodes[0], 1);
 789
 790         // Deliver (6), creating (7):
 791         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 792         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 793         assert!(commitment_update.update_add_htlcs.is_empty());
 794         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 795         assert!(commitment_update.update_fail_htlcs.is_empty());
 796         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 797         assert!(commitment_update.update_fee.is_none());
 798         check_added_monitors!(nodes[1], 1);
 799
 800         // Deliver (7)
 801         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 802         check_added_monitors!(nodes[0], 1);
 803         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 804         // No commitment_signed so get_event_msg's assert(len == 1) passes
 805
 806         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 807         check_added_monitors!(nodes[1], 1);
 808         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 809
 810         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 811         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 812         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 813 }
 814
 815 #[test]
 816 fn pre_funding_lock_shutdown_test() {
 817         // Test sending a shutdown prior to funding_locked after funding generation
 818         let chanmon_cfgs = create_chanmon_cfgs(2);
 819         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 820         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 821         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 822         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 823         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 824         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 825         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 826
 827         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 828         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 829         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 830         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 831         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 832
 833         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 834         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 835         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 836         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 837         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 838         assert!(node_0_none.is_none());
 839
 840         assert!(nodes[0].node.list_channels().is_empty());
 841         assert!(nodes[1].node.list_channels().is_empty());
 842 }
 843
 844 #[test]
 845 fn updates_shutdown_wait() {
 846         // Test sending a shutdown with outstanding updates pending
 847         let chanmon_cfgs = create_chanmon_cfgs(3);
 848         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 849         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 850         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 851         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 852         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 853         let logger = test_utils::TestLogger::new();
 854
 855         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 856
 857         nodes[0].node.close_channel(&chan_1.2).unwrap();
 858         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 859         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 860         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 861         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 862
 863         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 864         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 865
 866         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 867
 868         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 869         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 870         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();
 871         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();
 872         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 873         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 874
 875         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 876         check_added_monitors!(nodes[2], 1);
 877         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 878         assert!(updates.update_add_htlcs.is_empty());
 879         assert!(updates.update_fail_htlcs.is_empty());
 880         assert!(updates.update_fail_malformed_htlcs.is_empty());
 881         assert!(updates.update_fee.is_none());
 882         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 883         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 884         check_added_monitors!(nodes[1], 1);
 885         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 886         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 887
 888         assert!(updates_2.update_add_htlcs.is_empty());
 889         assert!(updates_2.update_fail_htlcs.is_empty());
 890         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 891         assert!(updates_2.update_fee.is_none());
 892         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 893         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 894         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 895
 896         let events = nodes[0].node.get_and_clear_pending_events();
 897         assert_eq!(events.len(), 1);
 898         match events[0] {
 899                 Event::PaymentSent { ref payment_preimage } => {
 900                         assert_eq!(our_payment_preimage, *payment_preimage);
 901                 },
 902                 _ => panic!("Unexpected event"),
 903         }
 904
 905         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 906         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 907         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 908         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 909         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 910         assert!(node_0_none.is_none());
 911
 912         assert!(nodes[0].node.list_channels().is_empty());
 913
 914         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 915         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 916         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 917         assert!(nodes[1].node.list_channels().is_empty());
 918         assert!(nodes[2].node.list_channels().is_empty());
 919 }
 920
 921 #[test]
 922 fn htlc_fail_async_shutdown() {
 923         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 924         let chanmon_cfgs = create_chanmon_cfgs(3);
 925         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 926         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 927         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 928         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 929         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 930         let logger = test_utils::TestLogger::new();
 931
 932         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 933         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 934         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();
 935         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 936         check_added_monitors!(nodes[0], 1);
 937         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 938         assert_eq!(updates.update_add_htlcs.len(), 1);
 939         assert!(updates.update_fulfill_htlcs.is_empty());
 940         assert!(updates.update_fail_htlcs.is_empty());
 941         assert!(updates.update_fail_malformed_htlcs.is_empty());
 942         assert!(updates.update_fee.is_none());
 943
 944         nodes[1].node.close_channel(&chan_1.2).unwrap();
 945         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 946         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 947         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 948
 949         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 950         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 951         check_added_monitors!(nodes[1], 1);
 952         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 953         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 954
 955         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 956         assert!(updates_2.update_add_htlcs.is_empty());
 957         assert!(updates_2.update_fulfill_htlcs.is_empty());
 958         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 959         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 960         assert!(updates_2.update_fee.is_none());
 961
 962         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 963         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 964
 965         expect_payment_failed!(nodes[0], our_payment_hash, false);
 966
 967         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 968         assert_eq!(msg_events.len(), 2);
 969         let node_0_closing_signed = match msg_events[0] {
 970                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 971                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 972                         (*msg).clone()
 973                 },
 974                 _ => panic!("Unexpected event"),
 975         };
 976         match msg_events[1] {
 977                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 978                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 979                 },
 980                 _ => panic!("Unexpected event"),
 981         }
 982
 983         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 984         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 985         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 986         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 987         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 988         assert!(node_0_none.is_none());
 989
 990         assert!(nodes[0].node.list_channels().is_empty());
 991
 992         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 993         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 994         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 995         assert!(nodes[1].node.list_channels().is_empty());
 996         assert!(nodes[2].node.list_channels().is_empty());
 997 }
 998
 999 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1000         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1001         // messages delivered prior to disconnect
1002         let chanmon_cfgs = create_chanmon_cfgs(3);
1003         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1004         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1005         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1006         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1007         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1008
1009         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1010
1011         nodes[1].node.close_channel(&chan_1.2).unwrap();
1012         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1013         if recv_count > 0 {
1014                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1015                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1016                 if recv_count > 1 {
1017                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1018                 }
1019         }
1020
1021         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1022         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1023
1024         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1025         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1026         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1027         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1028
1029         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1030         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1031         assert!(node_1_shutdown == node_1_2nd_shutdown);
1032
1033         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1034         let node_0_2nd_shutdown = if recv_count > 0 {
1035                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1036                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1037                 node_0_2nd_shutdown
1038         } else {
1039                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1040                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1041                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1042         };
1043         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1044
1045         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1046         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1047
1048         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1049         check_added_monitors!(nodes[2], 1);
1050         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1051         assert!(updates.update_add_htlcs.is_empty());
1052         assert!(updates.update_fail_htlcs.is_empty());
1053         assert!(updates.update_fail_malformed_htlcs.is_empty());
1054         assert!(updates.update_fee.is_none());
1055         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1056         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1057         check_added_monitors!(nodes[1], 1);
1058         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1059         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1060
1061         assert!(updates_2.update_add_htlcs.is_empty());
1062         assert!(updates_2.update_fail_htlcs.is_empty());
1063         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1064         assert!(updates_2.update_fee.is_none());
1065         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1066         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1067         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1068
1069         let events = nodes[0].node.get_and_clear_pending_events();
1070         assert_eq!(events.len(), 1);
1071         match events[0] {
1072                 Event::PaymentSent { ref payment_preimage } => {
1073                         assert_eq!(our_payment_preimage, *payment_preimage);
1074                 },
1075                 _ => panic!("Unexpected event"),
1076         }
1077
1078         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1079         if recv_count > 0 {
1080                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1081                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1082                 assert!(node_1_closing_signed.is_some());
1083         }
1084
1085         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1086         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1087
1088         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1089         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1090         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1091         if recv_count == 0 {
1092                 // If all closing_signeds weren't delivered we can just resume where we left off...
1093                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1094
1095                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1096                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1097                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1098
1099                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1100                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1101                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1102
1103                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1104                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1105
1106                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1107                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1108                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1109
1110                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1111                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1112                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1113                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1114                 assert!(node_0_none.is_none());
1115         } else {
1116                 // If one node, however, received + responded with an identical closing_signed we end
1117                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1118                 // There isn't really anything better we can do simply, but in the future we might
1119                 // explore storing a set of recently-closed channels that got disconnected during
1120                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1121                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1122                 // transaction.
1123                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1124
1125                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1126                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1127                 assert_eq!(msg_events.len(), 1);
1128                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1129                         match action {
1130                                 &ErrorAction::SendErrorMessage { ref msg } => {
1131                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1132                                         assert_eq!(msg.channel_id, chan_1.2);
1133                                 },
1134                                 _ => panic!("Unexpected event!"),
1135                         }
1136                 } else { panic!("Needed SendErrorMessage close"); }
1137
1138                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1139                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1140                 // closing_signed so we do it ourselves
1141                 check_closed_broadcast!(nodes[0], false);
1142                 check_added_monitors!(nodes[0], 1);
1143         }
1144
1145         assert!(nodes[0].node.list_channels().is_empty());
1146
1147         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1148         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1149         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1150         assert!(nodes[1].node.list_channels().is_empty());
1151         assert!(nodes[2].node.list_channels().is_empty());
1152 }
1153
1154 #[test]
1155 fn test_shutdown_rebroadcast() {
1156         do_test_shutdown_rebroadcast(0);
1157         do_test_shutdown_rebroadcast(1);
1158         do_test_shutdown_rebroadcast(2);
1159 }
1160
1161 #[test]
1162 fn fake_network_test() {
1163         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1164         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1165         let chanmon_cfgs = create_chanmon_cfgs(4);
1166         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1167         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1168         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1169
1170         // Create some initial channels
1171         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1172         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1173         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1174
1175         // Rebalance the network a bit by relaying one payment through all the channels...
1176         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1177         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1178         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1179         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1180
1181         // Send some more payments
1182         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1183         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1184         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1185
1186         // Test failure packets
1187         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1188         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1189
1190         // Add a new channel that skips 3
1191         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1192
1193         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1194         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1195         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1196         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1197         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1198         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1199         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1200
1201         // Do some rebalance loop payments, simultaneously
1202         let mut hops = Vec::with_capacity(3);
1203         hops.push(RouteHop {
1204                 pubkey: nodes[2].node.get_our_node_id(),
1205                 node_features: NodeFeatures::empty(),
1206                 short_channel_id: chan_2.0.contents.short_channel_id,
1207                 channel_features: ChannelFeatures::empty(),
1208                 fee_msat: 0,
1209                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1210         });
1211         hops.push(RouteHop {
1212                 pubkey: nodes[3].node.get_our_node_id(),
1213                 node_features: NodeFeatures::empty(),
1214                 short_channel_id: chan_3.0.contents.short_channel_id,
1215                 channel_features: ChannelFeatures::empty(),
1216                 fee_msat: 0,
1217                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1218         });
1219         hops.push(RouteHop {
1220                 pubkey: nodes[1].node.get_our_node_id(),
1221                 node_features: NodeFeatures::empty(),
1222                 short_channel_id: chan_4.0.contents.short_channel_id,
1223                 channel_features: ChannelFeatures::empty(),
1224                 fee_msat: 1000000,
1225                 cltv_expiry_delta: TEST_FINAL_CLTV,
1226         });
1227         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;
1228         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;
1229         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1230
1231         let mut hops = Vec::with_capacity(3);
1232         hops.push(RouteHop {
1233                 pubkey: nodes[3].node.get_our_node_id(),
1234                 node_features: NodeFeatures::empty(),
1235                 short_channel_id: chan_4.0.contents.short_channel_id,
1236                 channel_features: ChannelFeatures::empty(),
1237                 fee_msat: 0,
1238                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1239         });
1240         hops.push(RouteHop {
1241                 pubkey: nodes[2].node.get_our_node_id(),
1242                 node_features: NodeFeatures::empty(),
1243                 short_channel_id: chan_3.0.contents.short_channel_id,
1244                 channel_features: ChannelFeatures::empty(),
1245                 fee_msat: 0,
1246                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1247         });
1248         hops.push(RouteHop {
1249                 pubkey: nodes[1].node.get_our_node_id(),
1250                 node_features: NodeFeatures::empty(),
1251                 short_channel_id: chan_2.0.contents.short_channel_id,
1252                 channel_features: ChannelFeatures::empty(),
1253                 fee_msat: 1000000,
1254                 cltv_expiry_delta: TEST_FINAL_CLTV,
1255         });
1256         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;
1257         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;
1258         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1259
1260         // Claim the rebalances...
1261         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1262         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1263
1264         // Add a duplicate new channel from 2 to 4
1265         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1266
1267         // Send some payments across both channels
1268         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1269         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1270         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1271
1272
1273         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1274         let events = nodes[0].node.get_and_clear_pending_msg_events();
1275         assert_eq!(events.len(), 0);
1276         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);
1277
1278         //TODO: Test that routes work again here as we've been notified that the channel is full
1279
1280         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1281         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1282         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1283
1284         // Close down the channels...
1285         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1286         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1287         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1288         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1289         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1290 }
1291
1292 #[test]
1293 fn holding_cell_htlc_counting() {
1294         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1295         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1296         // commitment dance rounds.
1297         let chanmon_cfgs = create_chanmon_cfgs(3);
1298         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1299         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1300         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1301         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1302         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1303         let logger = test_utils::TestLogger::new();
1304
1305         let mut payments = Vec::new();
1306         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1307                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1308                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1309                 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();
1310                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1311                 payments.push((payment_preimage, payment_hash));
1312         }
1313         check_added_monitors!(nodes[1], 1);
1314
1315         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1316         assert_eq!(events.len(), 1);
1317         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1318         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1319
1320         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1321         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1322         // another HTLC.
1323         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1324         {
1325                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1326                 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();
1327                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1328                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1329                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1330                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1331         }
1332
1333         // This should also be true if we try to forward a payment.
1334         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1335         {
1336                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1337                 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();
1338                 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1339                 check_added_monitors!(nodes[0], 1);
1340         }
1341
1342         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1343         assert_eq!(events.len(), 1);
1344         let payment_event = SendEvent::from_event(events.pop().unwrap());
1345         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1346
1347         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1348         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1349         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1350         // fails), the second will process the resulting failure and fail the HTLC backward.
1351         expect_pending_htlcs_forwardable!(nodes[1]);
1352         expect_pending_htlcs_forwardable!(nodes[1]);
1353         check_added_monitors!(nodes[1], 1);
1354
1355         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1356         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1357         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1358
1359         let events = nodes[0].node.get_and_clear_pending_msg_events();
1360         assert_eq!(events.len(), 1);
1361         match events[0] {
1362                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1363                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1364                 },
1365                 _ => panic!("Unexpected event"),
1366         }
1367
1368         expect_payment_failed!(nodes[0], payment_hash_2, false);
1369
1370         // Now forward all the pending HTLCs and claim them back
1371         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1372         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1373         check_added_monitors!(nodes[2], 1);
1374
1375         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1376         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1377         check_added_monitors!(nodes[1], 1);
1378         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1379
1380         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1381         check_added_monitors!(nodes[1], 1);
1382         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1383
1384         for ref update in as_updates.update_add_htlcs.iter() {
1385                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1386         }
1387         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1388         check_added_monitors!(nodes[2], 1);
1389         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1390         check_added_monitors!(nodes[2], 1);
1391         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1392
1393         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1394         check_added_monitors!(nodes[1], 1);
1395         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1396         check_added_monitors!(nodes[1], 1);
1397         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1398
1399         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1400         check_added_monitors!(nodes[2], 1);
1401
1402         expect_pending_htlcs_forwardable!(nodes[2]);
1403
1404         let events = nodes[2].node.get_and_clear_pending_events();
1405         assert_eq!(events.len(), payments.len());
1406         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1407                 match event {
1408                         &Event::PaymentReceived { ref payment_hash, .. } => {
1409                                 assert_eq!(*payment_hash, *hash);
1410                         },
1411                         _ => panic!("Unexpected event"),
1412                 };
1413         }
1414
1415         for (preimage, _) in payments.drain(..) {
1416                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1417         }
1418
1419         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1420 }
1421
1422 #[test]
1423 fn duplicate_htlc_test() {
1424         // Test that we accept duplicate payment_hash HTLCs across the network and that
1425         // claiming/failing them are all separate and don't affect each other
1426         let chanmon_cfgs = create_chanmon_cfgs(6);
1427         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1428         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1429         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1430
1431         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1432         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1433         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1434         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1435         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1436         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1437
1438         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1439
1440         *nodes[0].network_payment_count.borrow_mut() -= 1;
1441         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1442
1443         *nodes[0].network_payment_count.borrow_mut() -= 1;
1444         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1445
1446         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1447         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1448         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1449 }
1450
1451 #[test]
1452 fn test_duplicate_htlc_different_direction_onchain() {
1453         // Test that ChannelMonitor doesn't generate 2 preimage txn
1454         // when we have 2 HTLCs with same preimage that go across a node
1455         // in opposite directions.
1456         let chanmon_cfgs = create_chanmon_cfgs(2);
1457         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1458         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1459         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1460
1461         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1462         let logger = test_utils::TestLogger::new();
1463
1464         // balancing
1465         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1466
1467         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1468
1469         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1470         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();
1471         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1472
1473         // Provide preimage to node 0 by claiming payment
1474         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1475         check_added_monitors!(nodes[0], 1);
1476
1477         // Broadcast node 1 commitment txn
1478         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1479
1480         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1481         let mut has_both_htlcs = 0; // check htlcs match ones committed
1482         for outp in remote_txn[0].output.iter() {
1483                 if outp.value == 800_000 / 1000 {
1484                         has_both_htlcs += 1;
1485                 } else if outp.value == 900_000 / 1000 {
1486                         has_both_htlcs += 1;
1487                 }
1488         }
1489         assert_eq!(has_both_htlcs, 2);
1490
1491         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1492         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1493         check_added_monitors!(nodes[0], 1);
1494
1495         // Check we only broadcast 1 timeout tx
1496         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1497         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()) };
1498         assert_eq!(claim_txn.len(), 5);
1499         check_spends!(claim_txn[2], chan_1.3);
1500         check_spends!(claim_txn[3], claim_txn[2]);
1501         assert_eq!(htlc_pair.0.input.len(), 1);
1502         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1503         check_spends!(htlc_pair.0, remote_txn[0]);
1504         assert_eq!(htlc_pair.1.input.len(), 1);
1505         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1506         check_spends!(htlc_pair.1, remote_txn[0]);
1507
1508         let events = nodes[0].node.get_and_clear_pending_msg_events();
1509         assert_eq!(events.len(), 2);
1510         for e in events {
1511                 match e {
1512                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1513                         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, .. } } => {
1514                                 assert!(update_add_htlcs.is_empty());
1515                                 assert!(update_fail_htlcs.is_empty());
1516                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1517                                 assert!(update_fail_malformed_htlcs.is_empty());
1518                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1519                         },
1520                         _ => panic!("Unexpected event"),
1521                 }
1522         }
1523 }
1524
1525 #[test]
1526 fn test_basic_channel_reserve() {
1527         let chanmon_cfgs = create_chanmon_cfgs(2);
1528         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1529         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1530         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1531         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1532         let logger = test_utils::TestLogger::new();
1533
1534         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1535         let channel_reserve = chan_stat.channel_reserve_msat;
1536
1537         // The 2* and +1 are for the fee spike reserve.
1538         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1539         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1540         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1541         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1542         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();
1543         let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1544         match err {
1545                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1546                         match &fails[0] {
1547                                 &APIError::ChannelUnavailable{ref err} =>
1548                                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
1549                                 _ => panic!("Unexpected error variant"),
1550                         }
1551                 },
1552                 _ => panic!("Unexpected error variant"),
1553         }
1554         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1555         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 1);
1556
1557         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1558 }
1559
1560 #[test]
1561 fn test_fee_spike_violation_fails_htlc() {
1562         let chanmon_cfgs = create_chanmon_cfgs(2);
1563         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1564         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1565         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1566         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1567         let logger = test_utils::TestLogger::new();
1568
1569         macro_rules! get_route_and_payment_hash {
1570                 ($recv_value: expr) => {{
1571                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1572                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1573                         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();
1574                         (route, payment_hash, payment_preimage)
1575                 }}
1576         };
1577
1578         let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
1579         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1580         let secp_ctx = Secp256k1::new();
1581         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1582
1583         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1584
1585         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1586         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1587         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1588         let msg = msgs::UpdateAddHTLC {
1589                 channel_id: chan.2,
1590                 htlc_id: 0,
1591                 amount_msat: htlc_msat,
1592                 payment_hash: payment_hash,
1593                 cltv_expiry: htlc_cltv,
1594                 onion_routing_packet: onion_packet,
1595         };
1596
1597         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1598
1599         // Now manually create the commitment_signed message corresponding to the update_add
1600         // nodes[0] just sent. In the code for construction of this message, "local" refers
1601         // to the sender of the message, and "remote" refers to the receiver.
1602
1603         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1604
1605         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1606
1607         // Get the EnforcingChannelKeys for each channel, which will be used to (1) get the keys
1608         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1609         let (local_revocation_basepoint, local_htlc_basepoint, local_payment_point, local_secret, local_secret2) = {
1610                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1611                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1612                 let chan_keys = local_chan.get_local_keys();
1613                 let pubkeys = chan_keys.pubkeys();
1614                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1615                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER), chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2))
1616         };
1617         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_payment_point, remote_secret1) = {
1618                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1619                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1620                 let chan_keys = remote_chan.get_local_keys();
1621                 let pubkeys = chan_keys.pubkeys();
1622                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1623                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1))
1624         };
1625
1626         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1627         let commitment_secret = SecretKey::from_slice(&remote_secret1).unwrap();
1628         let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &commitment_secret);
1629         let commit_tx_keys = chan_utils::TxCreationKeys::new(&secp_ctx, &per_commitment_point, &remote_delayed_payment_basepoint,
1630                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1631
1632         // Build the remote commitment transaction so we can sign it, and then later use the
1633         // signature for the commitment_signed message.
1634         let local_chan_balance = 1313;
1635         let static_payment_pk = local_payment_point.serialize();
1636         let remote_commit_tx_output = TxOut {
1637                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1638                                                              .push_slice(&WPubkeyHash::hash(&static_payment_pk)[..])
1639                                                              .into_script(),
1640                 value: local_chan_balance as u64
1641         };
1642
1643         let local_commit_tx_output = TxOut {
1644                 script_pubkey: chan_utils::get_revokeable_redeemscript(&commit_tx_keys.revocation_key,
1645                                                                                BREAKDOWN_TIMEOUT,
1646                                                                                &commit_tx_keys.a_delayed_payment_key).to_v0_p2wsh(),
1647                                 value: 95000,
1648         };
1649
1650         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1651                 offered: false,
1652                 amount_msat: 3460001,
1653                 cltv_expiry: htlc_cltv,
1654                 payment_hash: payment_hash,
1655                 transaction_output_index: Some(1),
1656         };
1657
1658         let htlc_output = TxOut {
1659                 script_pubkey: chan_utils::get_htlc_redeemscript(&accepted_htlc_info, &commit_tx_keys).to_v0_p2wsh(),
1660                 value: 3460001 / 1000
1661         };
1662
1663         let commit_tx_obscure_factor = {
1664                 let mut sha = Sha256::engine();
1665                 let remote_payment_point = &remote_payment_point.serialize();
1666                 sha.input(&local_payment_point.serialize());
1667                 sha.input(remote_payment_point);
1668                 let res = Sha256::from_engine(sha).into_inner();
1669
1670                 ((res[26] as u64) << 5*8) |
1671                 ((res[27] as u64) << 4*8) |
1672                 ((res[28] as u64) << 3*8) |
1673                 ((res[29] as u64) << 2*8) |
1674                 ((res[30] as u64) << 1*8) |
1675                 ((res[31] as u64) << 0*8)
1676         };
1677         let commitment_number = 1;
1678         let obscured_commitment_transaction_number = commit_tx_obscure_factor ^ commitment_number;
1679         let lock_time = ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32);
1680         let input = TxIn {
1681                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
1682                 script_sig: Script::new(),
1683                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
1684                 witness: Vec::new(),
1685         };
1686
1687         let commit_tx = Transaction {
1688                 version: 2,
1689                 lock_time,
1690                 input: vec![input],
1691                 output: vec![remote_commit_tx_output, htlc_output, local_commit_tx_output],
1692         };
1693         let res = {
1694                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1695                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1696                 let local_chan_keys = local_chan.get_local_keys();
1697                 local_chan_keys.sign_remote_commitment(feerate_per_kw, &commit_tx, &commit_tx_keys, &[&accepted_htlc_info], &secp_ctx).unwrap()
1698         };
1699
1700         let commit_signed_msg = msgs::CommitmentSigned {
1701                 channel_id: chan.2,
1702                 signature: res.0,
1703                 htlc_signatures: res.1
1704         };
1705
1706         // Send the commitment_signed message to the nodes[1].
1707         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1708         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1709
1710         // Send the RAA to nodes[1].
1711         let per_commitment_secret = local_secret;
1712         let next_secret = SecretKey::from_slice(&local_secret2).unwrap();
1713         let next_per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &next_secret);
1714         let raa_msg = msgs::RevokeAndACK{ channel_id: chan.2, per_commitment_secret, next_per_commitment_point};
1715         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1716
1717         let events = nodes[1].node.get_and_clear_pending_msg_events();
1718         assert_eq!(events.len(), 1);
1719         // Make sure the HTLC failed in the way we expect.
1720         match events[0] {
1721                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1722                         assert_eq!(update_fail_htlcs.len(), 1);
1723                         update_fail_htlcs[0].clone()
1724                 },
1725                 _ => panic!("Unexpected event"),
1726         };
1727         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1728
1729         check_added_monitors!(nodes[1], 2);
1730 }
1731
1732 #[test]
1733 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1734         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1735         // Set the fee rate for the channel very high, to the point where the fundee
1736         // sending any amount would result in a channel reserve violation. In this test
1737         // we check that we would be prevented from sending an HTLC in this situation.
1738         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1739         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1740         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1741         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1742         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1743         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1744         let logger = test_utils::TestLogger::new();
1745
1746         macro_rules! get_route_and_payment_hash {
1747                 ($recv_value: expr) => {{
1748                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1749                         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1750                         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();
1751                         (route, payment_hash, payment_preimage)
1752                 }}
1753         };
1754
1755         let (route, our_payment_hash, _) = get_route_and_payment_hash!(1000);
1756         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1757                 assert_eq!(err, "Cannot send value that would put them under remote channel reserve value"));
1758         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1759         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put them under remote channel reserve value".to_string(), 1);
1760 }
1761
1762 #[test]
1763 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1764         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1765         // Set the fee rate for the channel very high, to the point where the funder
1766         // receiving 1 update_add_htlc would result in them closing the channel due
1767         // to channel reserve violation. This close could also happen if the fee went
1768         // up a more realistic amount, but many HTLCs were outstanding at the time of
1769         // the update_add_htlc.
1770         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1771         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1772         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1773         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1774         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1775         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1776         let logger = test_utils::TestLogger::new();
1777
1778         macro_rules! get_route_and_payment_hash {
1779                 ($recv_value: expr) => {{
1780                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1781                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1782                         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();
1783                         (route, payment_hash, payment_preimage)
1784                 }}
1785         };
1786
1787         let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1788         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1789         let secp_ctx = Secp256k1::new();
1790         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1791         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1792         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1793         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1794         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1795         let msg = msgs::UpdateAddHTLC {
1796                 channel_id: chan.2,
1797                 htlc_id: 1,
1798                 amount_msat: htlc_msat + 1,
1799                 payment_hash: payment_hash,
1800                 cltv_expiry: htlc_cltv,
1801                 onion_routing_packet: onion_packet,
1802         };
1803
1804         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1805         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1806         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot receive value that would put us under local channel reserve value".to_string(), 1);
1807         assert_eq!(nodes[0].node.list_channels().len(), 0);
1808         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1809         assert_eq!(err_msg.data, "Cannot receive value that would put us under local channel reserve value");
1810         check_added_monitors!(nodes[0], 1);
1811 }
1812
1813 #[test]
1814 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1815         let chanmon_cfgs = create_chanmon_cfgs(3);
1816         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1817         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1818         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1819         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1820         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1821         let logger = test_utils::TestLogger::new();
1822
1823         macro_rules! get_route_and_payment_hash {
1824                 ($recv_value: expr) => {{
1825                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1826                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1827                         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();
1828                         (route, payment_hash, payment_preimage)
1829                 }}
1830         };
1831
1832         let feemsat = 239;
1833         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1834         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1835         let feerate = get_feerate!(nodes[0], chan.2);
1836
1837         // Add a 2* and +1 for the fee spike reserve.
1838         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1839         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;
1840         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1841
1842         // Add a pending HTLC.
1843         let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1844         let payment_event_1 = {
1845                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1846                 check_added_monitors!(nodes[0], 1);
1847
1848                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1849                 assert_eq!(events.len(), 1);
1850                 SendEvent::from_event(events.remove(0))
1851         };
1852         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1853
1854         // Attempt to trigger a channel reserve violation --> payment failure.
1855         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1856         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;
1857         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1858         let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1859
1860         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1861         let secp_ctx = Secp256k1::new();
1862         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1863         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1864         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1865         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1866         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1867         let msg = msgs::UpdateAddHTLC {
1868                 channel_id: chan.2,
1869                 htlc_id: 1,
1870                 amount_msat: htlc_msat + 1,
1871                 payment_hash: our_payment_hash_1,
1872                 cltv_expiry: htlc_cltv,
1873                 onion_routing_packet: onion_packet,
1874         };
1875
1876         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1877         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1878         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1879         assert_eq!(nodes[1].node.list_channels().len(), 1);
1880         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1881         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1882         check_added_monitors!(nodes[1], 1);
1883 }
1884
1885 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1886         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1887 }
1888
1889 #[test]
1890 fn test_channel_reserve_holding_cell_htlcs() {
1891         let chanmon_cfgs = create_chanmon_cfgs(3);
1892         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1893         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1894         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1895         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1896         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1897         let logger = test_utils::TestLogger::new();
1898
1899         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1900         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1901
1902         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1903         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1904
1905         macro_rules! get_route_and_payment_hash {
1906                 ($recv_value: expr) => {{
1907                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1908                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1909                         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();
1910                         (route, payment_hash, payment_preimage)
1911                 }}
1912         };
1913
1914         macro_rules! expect_forward {
1915                 ($node: expr) => {{
1916                         let mut events = $node.node.get_and_clear_pending_msg_events();
1917                         assert_eq!(events.len(), 1);
1918                         check_added_monitors!($node, 1);
1919                         let payment_event = SendEvent::from_event(events.remove(0));
1920                         payment_event
1921                 }}
1922         }
1923
1924         let feemsat = 239; // somehow we know?
1925         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1926         let feerate = get_feerate!(nodes[0], chan_1.2);
1927
1928         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1929
1930         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1931         {
1932                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1933                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1934                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1935                         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)));
1936                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1937                 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);
1938         }
1939
1940         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1941         // nodes[0]'s wealth
1942         loop {
1943                 let amt_msat = recv_value_0 + total_fee_msat;
1944                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1945                 // Also, ensure that each payment has enough to be over the dust limit to
1946                 // ensure it'll be included in each commit tx fee calculation.
1947                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1948                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.their_dust_limit_msat + 1000);
1949                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1950                         break;
1951                 }
1952                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1953
1954                 let (stat01_, stat11_, stat12_, stat22_) = (
1955                         get_channel_value_stat!(nodes[0], chan_1.2),
1956                         get_channel_value_stat!(nodes[1], chan_1.2),
1957                         get_channel_value_stat!(nodes[1], chan_2.2),
1958                         get_channel_value_stat!(nodes[2], chan_2.2),
1959                 );
1960
1961                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1962                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1963                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1964                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1965                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1966         }
1967
1968         // adding pending output.
1969         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1970         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1971         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1972         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1973         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1974         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1975         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1976         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1977         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1978         // policy.
1979         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1980         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1981         let amt_msat_1 = recv_value_1 + total_fee_msat;
1982
1983         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1984         let payment_event_1 = {
1985                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1986                 check_added_monitors!(nodes[0], 1);
1987
1988                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1989                 assert_eq!(events.len(), 1);
1990                 SendEvent::from_event(events.remove(0))
1991         };
1992         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1993
1994         // channel reserve test with htlc pending output > 0
1995         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
1996         {
1997                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1998                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1999                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)));
2000                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2001         }
2002
2003         // split the rest to test holding cell
2004         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2005         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2006         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2007         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2008         {
2009                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2010                 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);
2011         }
2012
2013         // now see if they go through on both sides
2014         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2015         // but this will stuck in the holding cell
2016         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2017         check_added_monitors!(nodes[0], 0);
2018         let events = nodes[0].node.get_and_clear_pending_events();
2019         assert_eq!(events.len(), 0);
2020
2021         // test with outbound holding cell amount > 0
2022         {
2023                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2024                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2025                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)));
2026                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2027                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 2);
2028         }
2029
2030         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2031         // this will also stuck in the holding cell
2032         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2033         check_added_monitors!(nodes[0], 0);
2034         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2035         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2036
2037         // flush the pending htlc
2038         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2039         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2040         check_added_monitors!(nodes[1], 1);
2041
2042         // the pending htlc should be promoted to committed
2043         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2044         check_added_monitors!(nodes[0], 1);
2045         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2046
2047         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2048         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2049         // No commitment_signed so get_event_msg's assert(len == 1) passes
2050         check_added_monitors!(nodes[0], 1);
2051
2052         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2053         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2054         check_added_monitors!(nodes[1], 1);
2055
2056         expect_pending_htlcs_forwardable!(nodes[1]);
2057
2058         let ref payment_event_11 = expect_forward!(nodes[1]);
2059         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2060         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2061
2062         expect_pending_htlcs_forwardable!(nodes[2]);
2063         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2064
2065         // flush the htlcs in the holding cell
2066         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2067         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2068         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2069         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2070         expect_pending_htlcs_forwardable!(nodes[1]);
2071
2072         let ref payment_event_3 = expect_forward!(nodes[1]);
2073         assert_eq!(payment_event_3.msgs.len(), 2);
2074         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2075         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2076
2077         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2078         expect_pending_htlcs_forwardable!(nodes[2]);
2079
2080         let events = nodes[2].node.get_and_clear_pending_events();
2081         assert_eq!(events.len(), 2);
2082         match events[0] {
2083                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2084                         assert_eq!(our_payment_hash_21, *payment_hash);
2085                         assert_eq!(*payment_secret, None);
2086                         assert_eq!(recv_value_21, amt);
2087                 },
2088                 _ => panic!("Unexpected event"),
2089         }
2090         match events[1] {
2091                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2092                         assert_eq!(our_payment_hash_22, *payment_hash);
2093                         assert_eq!(None, *payment_secret);
2094                         assert_eq!(recv_value_22, amt);
2095                 },
2096                 _ => panic!("Unexpected event"),
2097         }
2098
2099         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2100         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2101         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2102
2103         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2104         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2105         {
2106                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_3 + 1);
2107                 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
2108                 match err {
2109                         PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
2110                                 match &fails[0] {
2111                                         &APIError::ChannelUnavailable{ref err} =>
2112                                                 assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
2113                                         _ => panic!("Unexpected error variant"),
2114                                 }
2115                         },
2116                         _ => panic!("Unexpected error variant"),
2117                 }
2118                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2119                 nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 3);
2120         }
2121
2122         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2123
2124         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2125         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);
2126         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2127         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2128         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2129
2130         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2131         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2132 }
2133
2134 #[test]
2135 fn channel_reserve_in_flight_removes() {
2136         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2137         // can send to its counterparty, but due to update ordering, the other side may not yet have
2138         // considered those HTLCs fully removed.
2139         // This tests that we don't count HTLCs which will not be included in the next remote
2140         // commitment transaction towards the reserve value (as it implies no commitment transaction
2141         // will be generated which violates the remote reserve value).
2142         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2143         // To test this we:
2144         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2145         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2146         //    you only consider the value of the first HTLC, it may not),
2147         //  * start routing a third HTLC from A to B,
2148         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2149         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2150         //  * deliver the first fulfill from B
2151         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2152         //    claim,
2153         //  * deliver A's response CS and RAA.
2154         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2155         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2156         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2157         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2158         let chanmon_cfgs = create_chanmon_cfgs(2);
2159         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2160         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2161         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2162         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2163         let logger = test_utils::TestLogger::new();
2164
2165         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2166         // Route the first two HTLCs.
2167         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2168         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2169
2170         // Start routing the third HTLC (this is just used to get everyone in the right state).
2171         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2172         let send_1 = {
2173                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2174                 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();
2175                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2176                 check_added_monitors!(nodes[0], 1);
2177                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2178                 assert_eq!(events.len(), 1);
2179                 SendEvent::from_event(events.remove(0))
2180         };
2181
2182         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2183         // initial fulfill/CS.
2184         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2185         check_added_monitors!(nodes[1], 1);
2186         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2187
2188         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2189         // remove the second HTLC when we send the HTLC back from B to A.
2190         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2191         check_added_monitors!(nodes[1], 1);
2192         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2193
2194         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2195         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2196         check_added_monitors!(nodes[0], 1);
2197         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2198         expect_payment_sent!(nodes[0], payment_preimage_1);
2199
2200         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2201         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2202         check_added_monitors!(nodes[1], 1);
2203         // B is already AwaitingRAA, so cant generate a CS here
2204         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2205
2206         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2207         check_added_monitors!(nodes[1], 1);
2208         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2209
2210         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2211         check_added_monitors!(nodes[0], 1);
2212         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2213
2214         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2215         check_added_monitors!(nodes[1], 1);
2216         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2217
2218         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2219         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2220         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2221         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2222         // on-chain as necessary).
2223         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2224         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2225         check_added_monitors!(nodes[0], 1);
2226         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2227         expect_payment_sent!(nodes[0], payment_preimage_2);
2228
2229         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2230         check_added_monitors!(nodes[1], 1);
2231         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2232
2233         expect_pending_htlcs_forwardable!(nodes[1]);
2234         expect_payment_received!(nodes[1], payment_hash_3, 100000);
2235
2236         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2237         // resolve the second HTLC from A's point of view.
2238         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2239         check_added_monitors!(nodes[0], 1);
2240         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2241
2242         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2243         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2244         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2245         let send_2 = {
2246                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2247                 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();
2248                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2249                 check_added_monitors!(nodes[1], 1);
2250                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2251                 assert_eq!(events.len(), 1);
2252                 SendEvent::from_event(events.remove(0))
2253         };
2254
2255         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2256         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2257         check_added_monitors!(nodes[0], 1);
2258         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2259
2260         // Now just resolve all the outstanding messages/HTLCs for completeness...
2261
2262         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2263         check_added_monitors!(nodes[1], 1);
2264         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2265
2266         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2267         check_added_monitors!(nodes[1], 1);
2268
2269         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2270         check_added_monitors!(nodes[0], 1);
2271         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2272
2273         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2274         check_added_monitors!(nodes[1], 1);
2275         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2276
2277         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2278         check_added_monitors!(nodes[0], 1);
2279
2280         expect_pending_htlcs_forwardable!(nodes[0]);
2281         expect_payment_received!(nodes[0], payment_hash_4, 10000);
2282
2283         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2284         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2285 }
2286
2287 #[test]
2288 fn channel_monitor_network_test() {
2289         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2290         // tests that ChannelMonitor is able to recover from various states.
2291         let chanmon_cfgs = create_chanmon_cfgs(5);
2292         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2293         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2294         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2295
2296         // Create some initial channels
2297         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2298         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2299         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2300         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2301
2302         // Rebalance the network a bit by relaying one payment through all the channels...
2303         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2304         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2305         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2306         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2307
2308         // Simple case with no pending HTLCs:
2309         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2310         check_added_monitors!(nodes[1], 1);
2311         {
2312                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2313                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2314                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2315                 check_added_monitors!(nodes[0], 1);
2316                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2317         }
2318         get_announce_close_broadcast_events(&nodes, 0, 1);
2319         assert_eq!(nodes[0].node.list_channels().len(), 0);
2320         assert_eq!(nodes[1].node.list_channels().len(), 1);
2321
2322         // One pending HTLC is discarded by the force-close:
2323         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2324
2325         // Simple case of one pending HTLC to HTLC-Timeout
2326         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2327         check_added_monitors!(nodes[1], 1);
2328         {
2329                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2330                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2331                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2332                 check_added_monitors!(nodes[2], 1);
2333                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2334         }
2335         get_announce_close_broadcast_events(&nodes, 1, 2);
2336         assert_eq!(nodes[1].node.list_channels().len(), 0);
2337         assert_eq!(nodes[2].node.list_channels().len(), 1);
2338
2339         macro_rules! claim_funds {
2340                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2341                         {
2342                                 assert!($node.node.claim_funds($preimage, &None, $amount));
2343                                 check_added_monitors!($node, 1);
2344
2345                                 let events = $node.node.get_and_clear_pending_msg_events();
2346                                 assert_eq!(events.len(), 1);
2347                                 match events[0] {
2348                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2349                                                 assert!(update_add_htlcs.is_empty());
2350                                                 assert!(update_fail_htlcs.is_empty());
2351                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2352                                         },
2353                                         _ => panic!("Unexpected event"),
2354                                 };
2355                         }
2356                 }
2357         }
2358
2359         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2360         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2361         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2362         check_added_monitors!(nodes[2], 1);
2363         let node2_commitment_txid;
2364         {
2365                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2366                 node2_commitment_txid = node_txn[0].txid();
2367
2368                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2369                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2370
2371                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2372                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2373                 check_added_monitors!(nodes[3], 1);
2374
2375                 check_preimage_claim(&nodes[3], &node_txn);
2376         }
2377         get_announce_close_broadcast_events(&nodes, 2, 3);
2378         assert_eq!(nodes[2].node.list_channels().len(), 0);
2379         assert_eq!(nodes[3].node.list_channels().len(), 1);
2380
2381         { // Cheat and reset nodes[4]'s height to 1
2382                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2383                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2384         }
2385
2386         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2387         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2388         // One pending HTLC to time out:
2389         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2390         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2391         // buffer space).
2392
2393         {
2394                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2395                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2396                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2397                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2398                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2399                 }
2400                 check_added_monitors!(nodes[3], 1);
2401
2402                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2403                 {
2404                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2405                         node_txn.retain(|tx| {
2406                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2407                                         false
2408                                 } else { true }
2409                         });
2410                 }
2411
2412                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2413
2414                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2415                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2416
2417                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2418
2419                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2420                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2421                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2422                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2423                 }
2424
2425                 check_added_monitors!(nodes[4], 1);
2426                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2427
2428                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2429                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2430
2431                 check_preimage_claim(&nodes[4], &node_txn);
2432         }
2433         get_announce_close_broadcast_events(&nodes, 3, 4);
2434         assert_eq!(nodes[3].node.list_channels().len(), 0);
2435         assert_eq!(nodes[4].node.list_channels().len(), 0);
2436 }
2437
2438 #[test]
2439 fn test_justice_tx() {
2440         // Test justice txn built on revoked HTLC-Success tx, against both sides
2441         let mut alice_config = UserConfig::default();
2442         alice_config.channel_options.announced_channel = true;
2443         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2444         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2445         let mut bob_config = UserConfig::default();
2446         bob_config.channel_options.announced_channel = true;
2447         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2448         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2449         let user_cfgs = [Some(alice_config), Some(bob_config)];
2450         let chanmon_cfgs = create_chanmon_cfgs(2);
2451         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2452         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2453         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2454         // Create some new channels:
2455         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2456
2457         // A pending HTLC which will be revoked:
2458         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2459         // Get the will-be-revoked local txn from nodes[0]
2460         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2461         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2462         assert_eq!(revoked_local_txn[0].input.len(), 1);
2463         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2464         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2465         assert_eq!(revoked_local_txn[1].input.len(), 1);
2466         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2467         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2468         // Revoke the old state
2469         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2470
2471         {
2472                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2473                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2474                 {
2475                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2476                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2477                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2478
2479                         check_spends!(node_txn[0], revoked_local_txn[0]);
2480                         node_txn.swap_remove(0);
2481                         node_txn.truncate(1);
2482                 }
2483                 check_added_monitors!(nodes[1], 1);
2484                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2485
2486                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2487                 // Verify broadcast of revoked HTLC-timeout
2488                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2489                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2490                 check_added_monitors!(nodes[0], 1);
2491                 // Broadcast revoked HTLC-timeout on node 1
2492                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2493                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2494         }
2495         get_announce_close_broadcast_events(&nodes, 0, 1);
2496
2497         assert_eq!(nodes[0].node.list_channels().len(), 0);
2498         assert_eq!(nodes[1].node.list_channels().len(), 0);
2499
2500         // We test justice_tx build by A on B's revoked HTLC-Success tx
2501         // Create some new channels:
2502         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2503         {
2504                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2505                 node_txn.clear();
2506         }
2507
2508         // A pending HTLC which will be revoked:
2509         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2510         // Get the will-be-revoked local txn from B
2511         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2512         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2513         assert_eq!(revoked_local_txn[0].input.len(), 1);
2514         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2515         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2516         // Revoke the old state
2517         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2518         {
2519                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2520                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2521                 {
2522                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2523                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2524                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2525
2526                         check_spends!(node_txn[0], revoked_local_txn[0]);
2527                         node_txn.swap_remove(0);
2528                 }
2529                 check_added_monitors!(nodes[0], 1);
2530                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2531
2532                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2533                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2534                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2535                 check_added_monitors!(nodes[1], 1);
2536                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2537                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2538         }
2539         get_announce_close_broadcast_events(&nodes, 0, 1);
2540         assert_eq!(nodes[0].node.list_channels().len(), 0);
2541         assert_eq!(nodes[1].node.list_channels().len(), 0);
2542 }
2543
2544 #[test]
2545 fn revoked_output_claim() {
2546         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2547         // transaction is broadcast by its counterparty
2548         let chanmon_cfgs = create_chanmon_cfgs(2);
2549         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2550         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2551         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2552         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2553         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2554         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2555         assert_eq!(revoked_local_txn.len(), 1);
2556         // Only output is the full channel value back to nodes[0]:
2557         assert_eq!(revoked_local_txn[0].output.len(), 1);
2558         // Send a payment through, updating everyone's latest commitment txn
2559         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2560
2561         // Inform nodes[1] that nodes[0] broadcast a stale tx
2562         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2563         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2564         check_added_monitors!(nodes[1], 1);
2565         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2566         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2567
2568         check_spends!(node_txn[0], revoked_local_txn[0]);
2569         check_spends!(node_txn[1], chan_1.3);
2570
2571         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2572         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2573         get_announce_close_broadcast_events(&nodes, 0, 1);
2574         check_added_monitors!(nodes[0], 1)
2575 }
2576
2577 #[test]
2578 fn claim_htlc_outputs_shared_tx() {
2579         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2580         let chanmon_cfgs = create_chanmon_cfgs(2);
2581         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2582         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2583         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2584
2585         // Create some new channel:
2586         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2587
2588         // Rebalance the network to generate htlc in the two directions
2589         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2590         // 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
2591         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2592         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2593
2594         // Get the will-be-revoked local txn from node[0]
2595         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2596         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2597         assert_eq!(revoked_local_txn[0].input.len(), 1);
2598         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2599         assert_eq!(revoked_local_txn[1].input.len(), 1);
2600         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2601         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2602         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2603
2604         //Revoke the old state
2605         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2606
2607         {
2608                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2609                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2610                 check_added_monitors!(nodes[0], 1);
2611                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2612                 check_added_monitors!(nodes[1], 1);
2613                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2614                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2615
2616                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2617                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2618
2619                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2620                 check_spends!(node_txn[0], revoked_local_txn[0]);
2621
2622                 let mut witness_lens = BTreeSet::new();
2623                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2624                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2625                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2626                 assert_eq!(witness_lens.len(), 3);
2627                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2628                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2629                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2630
2631                 // Next nodes[1] broadcasts its current local tx state:
2632                 assert_eq!(node_txn[1].input.len(), 1);
2633                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2634
2635                 assert_eq!(node_txn[2].input.len(), 1);
2636                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2637                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2638                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2639                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2640                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2641         }
2642         get_announce_close_broadcast_events(&nodes, 0, 1);
2643         assert_eq!(nodes[0].node.list_channels().len(), 0);
2644         assert_eq!(nodes[1].node.list_channels().len(), 0);
2645 }
2646
2647 #[test]
2648 fn claim_htlc_outputs_single_tx() {
2649         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2650         let chanmon_cfgs = create_chanmon_cfgs(2);
2651         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2652         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2653         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2654
2655         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2656
2657         // Rebalance the network to generate htlc in the two directions
2658         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2659         // 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
2660         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2661         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2662         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2663
2664         // Get the will-be-revoked local txn from node[0]
2665         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2666
2667         //Revoke the old state
2668         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2669
2670         {
2671                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2672                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2673                 check_added_monitors!(nodes[0], 1);
2674                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2675                 check_added_monitors!(nodes[1], 1);
2676                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2677
2678                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2679                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2680
2681                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2682                 assert_eq!(node_txn.len(), 9);
2683                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2684                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2685                 // 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)
2686                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2687
2688                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2689                 assert_eq!(node_txn[2].input.len(), 1);
2690                 check_spends!(node_txn[2], chan_1.3);
2691                 assert_eq!(node_txn[3].input.len(), 1);
2692                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2693                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2694                 check_spends!(node_txn[3], node_txn[2]);
2695
2696                 // Justice transactions are indices 1-2-4
2697                 assert_eq!(node_txn[0].input.len(), 1);
2698                 assert_eq!(node_txn[1].input.len(), 1);
2699                 assert_eq!(node_txn[4].input.len(), 1);
2700
2701                 check_spends!(node_txn[0], revoked_local_txn[0]);
2702                 check_spends!(node_txn[1], revoked_local_txn[0]);
2703                 check_spends!(node_txn[4], revoked_local_txn[0]);
2704
2705                 let mut witness_lens = BTreeSet::new();
2706                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2707                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2708                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2709                 assert_eq!(witness_lens.len(), 3);
2710                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2711                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2712                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2713         }
2714         get_announce_close_broadcast_events(&nodes, 0, 1);
2715         assert_eq!(nodes[0].node.list_channels().len(), 0);
2716         assert_eq!(nodes[1].node.list_channels().len(), 0);
2717 }
2718
2719 #[test]
2720 fn test_htlc_on_chain_success() {
2721         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2722         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2723         // broadcasting the right event to other nodes in payment path.
2724         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2725         // A --------------------> B ----------------------> C (preimage)
2726         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2727         // commitment transaction was broadcast.
2728         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2729         // towards B.
2730         // B should be able to claim via preimage if A then broadcasts its local tx.
2731         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2732         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2733         // PaymentSent event).
2734
2735         let chanmon_cfgs = create_chanmon_cfgs(3);
2736         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2737         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2738         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2739
2740         // Create some initial channels
2741         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2742         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2743
2744         // Rebalance the network a bit by relaying one payment through all the channels...
2745         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2746         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2747
2748         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2749         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2750         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2751
2752         // Broadcast legit commitment tx from C on B's chain
2753         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2754         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2755         assert_eq!(commitment_tx.len(), 1);
2756         check_spends!(commitment_tx[0], chan_2.3);
2757         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2758         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2759         check_added_monitors!(nodes[2], 2);
2760         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2761         assert!(updates.update_add_htlcs.is_empty());
2762         assert!(updates.update_fail_htlcs.is_empty());
2763         assert!(updates.update_fail_malformed_htlcs.is_empty());
2764         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2765
2766         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2767         check_closed_broadcast!(nodes[2], false);
2768         check_added_monitors!(nodes[2], 1);
2769         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)
2770         assert_eq!(node_txn.len(), 5);
2771         assert_eq!(node_txn[0], node_txn[3]);
2772         assert_eq!(node_txn[1], node_txn[4]);
2773         assert_eq!(node_txn[2], commitment_tx[0]);
2774         check_spends!(node_txn[0], commitment_tx[0]);
2775         check_spends!(node_txn[1], commitment_tx[0]);
2776         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2777         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2778         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2779         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2780         assert_eq!(node_txn[0].lock_time, 0);
2781         assert_eq!(node_txn[1].lock_time, 0);
2782
2783         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2784         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2785         {
2786                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2787                 assert_eq!(added_monitors.len(), 1);
2788                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2789                 added_monitors.clear();
2790         }
2791         let events = nodes[1].node.get_and_clear_pending_msg_events();
2792         {
2793                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2794                 assert_eq!(added_monitors.len(), 2);
2795                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2796                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2797                 added_monitors.clear();
2798         }
2799         assert_eq!(events.len(), 2);
2800         match events[0] {
2801                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2802                 _ => panic!("Unexpected event"),
2803         }
2804         match events[1] {
2805                 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, .. } } => {
2806                         assert!(update_add_htlcs.is_empty());
2807                         assert!(update_fail_htlcs.is_empty());
2808                         assert_eq!(update_fulfill_htlcs.len(), 1);
2809                         assert!(update_fail_malformed_htlcs.is_empty());
2810                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2811                 },
2812                 _ => panic!("Unexpected event"),
2813         };
2814         macro_rules! check_tx_local_broadcast {
2815                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2816                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2817                         assert_eq!(node_txn.len(), 5);
2818                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2819                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2820                         check_spends!(node_txn[0], $commitment_tx);
2821                         check_spends!(node_txn[1], $commitment_tx);
2822                         assert_ne!(node_txn[0].lock_time, 0);
2823                         assert_ne!(node_txn[1].lock_time, 0);
2824                         if $htlc_offered {
2825                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2826                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2827                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2828                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2829                         } else {
2830                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2831                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2832                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2833                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2834                         }
2835                         check_spends!(node_txn[2], $chan_tx);
2836                         check_spends!(node_txn[3], node_txn[2]);
2837                         check_spends!(node_txn[4], node_txn[2]);
2838                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2839                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2840                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2841                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2842                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2843                         assert_ne!(node_txn[3].lock_time, 0);
2844                         assert_ne!(node_txn[4].lock_time, 0);
2845                         node_txn.clear();
2846                 } }
2847         }
2848         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2849         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2850         // timeout-claim of the output that nodes[2] just claimed via success.
2851         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2852
2853         // Broadcast legit commitment tx from A on B's chain
2854         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2855         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2856         check_spends!(commitment_tx[0], chan_1.3);
2857         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2858         check_closed_broadcast!(nodes[1], false);
2859         check_added_monitors!(nodes[1], 1);
2860         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2861         assert_eq!(node_txn.len(), 4);
2862         check_spends!(node_txn[0], commitment_tx[0]);
2863         assert_eq!(node_txn[0].input.len(), 2);
2864         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2865         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2866         assert_eq!(node_txn[0].lock_time, 0);
2867         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2868         check_spends!(node_txn[1], chan_1.3);
2869         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2870         check_spends!(node_txn[2], node_txn[1]);
2871         check_spends!(node_txn[3], node_txn[1]);
2872         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2873         // we already checked the same situation with A.
2874
2875         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2876         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2877         check_closed_broadcast!(nodes[0], false);
2878         check_added_monitors!(nodes[0], 1);
2879         let events = nodes[0].node.get_and_clear_pending_events();
2880         assert_eq!(events.len(), 2);
2881         let mut first_claimed = false;
2882         for event in events {
2883                 match event {
2884                         Event::PaymentSent { payment_preimage } => {
2885                                 if payment_preimage == our_payment_preimage {
2886                                         assert!(!first_claimed);
2887                                         first_claimed = true;
2888                                 } else {
2889                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2890                                 }
2891                         },
2892                         _ => panic!("Unexpected event"),
2893                 }
2894         }
2895         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2896 }
2897
2898 #[test]
2899 fn test_htlc_on_chain_timeout() {
2900         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2901         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2902         // broadcasting the right event to other nodes in payment path.
2903         // A ------------------> B ----------------------> C (timeout)
2904         //    B's commitment tx                 C's commitment tx
2905         //            \                                  \
2906         //         B's HTLC timeout tx               B's timeout tx
2907
2908         let chanmon_cfgs = create_chanmon_cfgs(3);
2909         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2910         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2911         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2912
2913         // Create some intial channels
2914         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2915         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2916
2917         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2918         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2919         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2920
2921         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2922         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2923
2924         // Broadcast legit commitment tx from C on B's chain
2925         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2926         check_spends!(commitment_tx[0], chan_2.3);
2927         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2928         check_added_monitors!(nodes[2], 0);
2929         expect_pending_htlcs_forwardable!(nodes[2]);
2930         check_added_monitors!(nodes[2], 1);
2931
2932         let events = nodes[2].node.get_and_clear_pending_msg_events();
2933         assert_eq!(events.len(), 1);
2934         match events[0] {
2935                 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, .. } } => {
2936                         assert!(update_add_htlcs.is_empty());
2937                         assert!(!update_fail_htlcs.is_empty());
2938                         assert!(update_fulfill_htlcs.is_empty());
2939                         assert!(update_fail_malformed_htlcs.is_empty());
2940                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2941                 },
2942                 _ => panic!("Unexpected event"),
2943         };
2944         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2945         check_closed_broadcast!(nodes[2], false);
2946         check_added_monitors!(nodes[2], 1);
2947         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2948         assert_eq!(node_txn.len(), 1);
2949         check_spends!(node_txn[0], chan_2.3);
2950         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2951
2952         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2953         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2954         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2955         let timeout_tx;
2956         {
2957                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2958                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2959                 assert_eq!(node_txn[1], node_txn[3]);
2960                 assert_eq!(node_txn[2], node_txn[4]);
2961
2962                 check_spends!(node_txn[0], commitment_tx[0]);
2963                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2964
2965                 check_spends!(node_txn[1], chan_2.3);
2966                 check_spends!(node_txn[2], node_txn[1]);
2967                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2968                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2969
2970                 timeout_tx = node_txn[0].clone();
2971                 node_txn.clear();
2972         }
2973
2974         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2975         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2976         check_added_monitors!(nodes[1], 1);
2977         check_closed_broadcast!(nodes[1], false);
2978
2979         expect_pending_htlcs_forwardable!(nodes[1]);
2980         check_added_monitors!(nodes[1], 1);
2981         let events = nodes[1].node.get_and_clear_pending_msg_events();
2982         assert_eq!(events.len(), 1);
2983         match events[0] {
2984                 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, .. } } => {
2985                         assert!(update_add_htlcs.is_empty());
2986                         assert!(!update_fail_htlcs.is_empty());
2987                         assert!(update_fulfill_htlcs.is_empty());
2988                         assert!(update_fail_malformed_htlcs.is_empty());
2989                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2990                 },
2991                 _ => panic!("Unexpected event"),
2992         };
2993         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
2994         assert_eq!(node_txn.len(), 0);
2995
2996         // Broadcast legit commitment tx from B on A's chain
2997         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2998         check_spends!(commitment_tx[0], chan_1.3);
2999
3000         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3001         check_closed_broadcast!(nodes[0], false);
3002         check_added_monitors!(nodes[0], 1);
3003         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3004         assert_eq!(node_txn.len(), 3);
3005         check_spends!(node_txn[0], commitment_tx[0]);
3006         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3007         check_spends!(node_txn[1], chan_1.3);
3008         check_spends!(node_txn[2], node_txn[1]);
3009         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3010         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3011 }
3012
3013 #[test]
3014 fn test_simple_commitment_revoked_fail_backward() {
3015         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3016         // and fail backward accordingly.
3017
3018         let chanmon_cfgs = create_chanmon_cfgs(3);
3019         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3020         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3021         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3022
3023         // Create some initial channels
3024         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3025         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3026
3027         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3028         // Get the will-be-revoked local txn from nodes[2]
3029         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3030         // Revoke the old state
3031         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3032
3033         let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3034
3035         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3036         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3037         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3038         check_added_monitors!(nodes[1], 1);
3039         check_closed_broadcast!(nodes[1], false);
3040
3041         expect_pending_htlcs_forwardable!(nodes[1]);
3042         check_added_monitors!(nodes[1], 1);
3043         let events = nodes[1].node.get_and_clear_pending_msg_events();
3044         assert_eq!(events.len(), 1);
3045         match events[0] {
3046                 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, .. } } => {
3047                         assert!(update_add_htlcs.is_empty());
3048                         assert_eq!(update_fail_htlcs.len(), 1);
3049                         assert!(update_fulfill_htlcs.is_empty());
3050                         assert!(update_fail_malformed_htlcs.is_empty());
3051                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3052
3053                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3054                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3055
3056                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3057                         assert_eq!(events.len(), 1);
3058                         match events[0] {
3059                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3060                                 _ => panic!("Unexpected event"),
3061                         }
3062                         expect_payment_failed!(nodes[0], payment_hash, false);
3063                 },
3064                 _ => panic!("Unexpected event"),
3065         }
3066 }
3067
3068 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3069         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3070         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3071         // commitment transaction anymore.
3072         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3073         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3074         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3075         // technically disallowed and we should probably handle it reasonably.
3076         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3077         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3078         // transactions:
3079         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3080         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3081         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3082         //   and once they revoke the previous commitment transaction (allowing us to send a new
3083         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3084         let chanmon_cfgs = create_chanmon_cfgs(3);
3085         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3086         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3087         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3088
3089         // Create some initial channels
3090         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3091         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3092
3093         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3094         // Get the will-be-revoked local txn from nodes[2]
3095         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3096         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3097         // Revoke the old state
3098         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3099
3100         let value = if use_dust {
3101                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3102                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3103                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
3104         } else { 3000000 };
3105
3106         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3107         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3108         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3109
3110         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3111         expect_pending_htlcs_forwardable!(nodes[2]);
3112         check_added_monitors!(nodes[2], 1);
3113         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3114         assert!(updates.update_add_htlcs.is_empty());
3115         assert!(updates.update_fulfill_htlcs.is_empty());
3116         assert!(updates.update_fail_malformed_htlcs.is_empty());
3117         assert_eq!(updates.update_fail_htlcs.len(), 1);
3118         assert!(updates.update_fee.is_none());
3119         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3120         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3121         // Drop the last RAA from 3 -> 2
3122
3123         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3124         expect_pending_htlcs_forwardable!(nodes[2]);
3125         check_added_monitors!(nodes[2], 1);
3126         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3127         assert!(updates.update_add_htlcs.is_empty());
3128         assert!(updates.update_fulfill_htlcs.is_empty());
3129         assert!(updates.update_fail_malformed_htlcs.is_empty());
3130         assert_eq!(updates.update_fail_htlcs.len(), 1);
3131         assert!(updates.update_fee.is_none());
3132         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3133         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3134         check_added_monitors!(nodes[1], 1);
3135         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3136         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3137         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3138         check_added_monitors!(nodes[2], 1);
3139
3140         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3141         expect_pending_htlcs_forwardable!(nodes[2]);
3142         check_added_monitors!(nodes[2], 1);
3143         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3144         assert!(updates.update_add_htlcs.is_empty());
3145         assert!(updates.update_fulfill_htlcs.is_empty());
3146         assert!(updates.update_fail_malformed_htlcs.is_empty());
3147         assert_eq!(updates.update_fail_htlcs.len(), 1);
3148         assert!(updates.update_fee.is_none());
3149         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3150         // At this point first_payment_hash has dropped out of the latest two commitment
3151         // transactions that nodes[1] is tracking...
3152         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3153         check_added_monitors!(nodes[1], 1);
3154         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3155         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3156         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3157         check_added_monitors!(nodes[2], 1);
3158
3159         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3160         // on nodes[2]'s RAA.
3161         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3162         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3163         let logger = test_utils::TestLogger::new();
3164         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();
3165         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3166         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3167         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3168         check_added_monitors!(nodes[1], 0);
3169
3170         if deliver_bs_raa {
3171                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3172                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3173                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3174                 check_added_monitors!(nodes[1], 1);
3175                 let events = nodes[1].node.get_and_clear_pending_events();
3176                 assert_eq!(events.len(), 1);
3177                 match events[0] {
3178                         Event::PendingHTLCsForwardable { .. } => { },
3179                         _ => panic!("Unexpected event"),
3180                 };
3181                 // Deliberately don't process the pending fail-back so they all fail back at once after
3182                 // block connection just like the !deliver_bs_raa case
3183         }
3184
3185         let mut failed_htlcs = HashSet::new();
3186         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3187
3188         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3189         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3190         check_added_monitors!(nodes[1], 1);
3191         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3192
3193         let events = nodes[1].node.get_and_clear_pending_events();
3194         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3195         match events[0] {
3196                 Event::PaymentFailed { ref payment_hash, .. } => {
3197                         assert_eq!(*payment_hash, fourth_payment_hash);
3198                 },
3199                 _ => panic!("Unexpected event"),
3200         }
3201         if !deliver_bs_raa {
3202                 match events[1] {
3203                         Event::PendingHTLCsForwardable { .. } => { },
3204                         _ => panic!("Unexpected event"),
3205                 };
3206         }
3207         nodes[1].node.process_pending_htlc_forwards();
3208         check_added_monitors!(nodes[1], 1);
3209
3210         let events = nodes[1].node.get_and_clear_pending_msg_events();
3211         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3212         match events[if deliver_bs_raa { 1 } else { 0 }] {
3213                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3214                 _ => panic!("Unexpected event"),
3215         }
3216         if deliver_bs_raa {
3217                 match events[0] {
3218                         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, .. } } => {
3219                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3220                                 assert_eq!(update_add_htlcs.len(), 1);
3221                                 assert!(update_fulfill_htlcs.is_empty());
3222                                 assert!(update_fail_htlcs.is_empty());
3223                                 assert!(update_fail_malformed_htlcs.is_empty());
3224                         },
3225                         _ => panic!("Unexpected event"),
3226                 }
3227         }
3228         match events[if deliver_bs_raa { 2 } else { 1 }] {
3229                 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, .. } } => {
3230                         assert!(update_add_htlcs.is_empty());
3231                         assert_eq!(update_fail_htlcs.len(), 3);
3232                         assert!(update_fulfill_htlcs.is_empty());
3233                         assert!(update_fail_malformed_htlcs.is_empty());
3234                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3235
3236                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3237                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3238                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3239
3240                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3241
3242                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3243                         // If we delivered B's RAA we got an unknown preimage error, not something
3244                         // that we should update our routing table for.
3245                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3246                         for event in events {
3247                                 match event {
3248                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3249                                         _ => panic!("Unexpected event"),
3250                                 }
3251                         }
3252                         let events = nodes[0].node.get_and_clear_pending_events();
3253                         assert_eq!(events.len(), 3);
3254                         match events[0] {
3255                                 Event::PaymentFailed { ref payment_hash, .. } => {
3256                                         assert!(failed_htlcs.insert(payment_hash.0));
3257                                 },
3258                                 _ => panic!("Unexpected event"),
3259                         }
3260                         match events[1] {
3261                                 Event::PaymentFailed { ref payment_hash, .. } => {
3262                                         assert!(failed_htlcs.insert(payment_hash.0));
3263                                 },
3264                                 _ => panic!("Unexpected event"),
3265                         }
3266                         match events[2] {
3267                                 Event::PaymentFailed { ref payment_hash, .. } => {
3268                                         assert!(failed_htlcs.insert(payment_hash.0));
3269                                 },
3270                                 _ => panic!("Unexpected event"),
3271                         }
3272                 },
3273                 _ => panic!("Unexpected event"),
3274         }
3275
3276         assert!(failed_htlcs.contains(&first_payment_hash.0));
3277         assert!(failed_htlcs.contains(&second_payment_hash.0));
3278         assert!(failed_htlcs.contains(&third_payment_hash.0));
3279 }
3280
3281 #[test]
3282 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3283         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3284         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3285         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3286         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3287 }
3288
3289 #[test]
3290 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3291         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3292         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3293         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3294         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3295 }
3296
3297 #[test]
3298 fn fail_backward_pending_htlc_upon_channel_failure() {
3299         let chanmon_cfgs = create_chanmon_cfgs(2);
3300         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3301         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3302         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3303         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3304         let logger = test_utils::TestLogger::new();
3305
3306         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3307         {
3308                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3309                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3310                 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();
3311                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3312                 check_added_monitors!(nodes[0], 1);
3313
3314                 let payment_event = {
3315                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3316                         assert_eq!(events.len(), 1);
3317                         SendEvent::from_event(events.remove(0))
3318                 };
3319                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3320                 assert_eq!(payment_event.msgs.len(), 1);
3321         }
3322
3323         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3324         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3325         {
3326                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3327                 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();
3328                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3329                 check_added_monitors!(nodes[0], 0);
3330
3331                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3332         }
3333
3334         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3335         {
3336                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3337
3338                 let secp_ctx = Secp256k1::new();
3339                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3340                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3341                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3342                 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();
3343                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3344                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3345                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3346
3347                 // Send a 0-msat update_add_htlc to fail the channel.
3348                 let update_add_htlc = msgs::UpdateAddHTLC {
3349                         channel_id: chan.2,
3350                         htlc_id: 0,
3351                         amount_msat: 0,
3352                         payment_hash,
3353                         cltv_expiry,
3354                         onion_routing_packet,
3355                 };
3356                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3357         }
3358
3359         // Check that Alice fails backward the pending HTLC from the second payment.
3360         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3361         check_closed_broadcast!(nodes[0], true);
3362         check_added_monitors!(nodes[0], 1);
3363 }
3364
3365 #[test]
3366 fn test_htlc_ignore_latest_remote_commitment() {
3367         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3368         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3369         let chanmon_cfgs = create_chanmon_cfgs(2);
3370         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3371         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3372         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3373         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3374
3375         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3376         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3377         check_closed_broadcast!(nodes[0], false);
3378         check_added_monitors!(nodes[0], 1);
3379
3380         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3381         assert_eq!(node_txn.len(), 2);
3382
3383         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3384         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3385         check_closed_broadcast!(nodes[1], false);
3386         check_added_monitors!(nodes[1], 1);
3387
3388         // Duplicate the block_connected call since this may happen due to other listeners
3389         // registering new transactions
3390         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3391 }
3392
3393 #[test]
3394 fn test_force_close_fail_back() {
3395         // Check which HTLCs are failed-backwards on channel force-closure
3396         let chanmon_cfgs = create_chanmon_cfgs(3);
3397         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3398         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3399         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3400         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3401         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3402         let logger = test_utils::TestLogger::new();
3403
3404         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3405
3406         let mut payment_event = {
3407                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3408                 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();
3409                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3410                 check_added_monitors!(nodes[0], 1);
3411
3412                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3413                 assert_eq!(events.len(), 1);
3414                 SendEvent::from_event(events.remove(0))
3415         };
3416
3417         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3418         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3419
3420         expect_pending_htlcs_forwardable!(nodes[1]);
3421
3422         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3423         assert_eq!(events_2.len(), 1);
3424         payment_event = SendEvent::from_event(events_2.remove(0));
3425         assert_eq!(payment_event.msgs.len(), 1);
3426
3427         check_added_monitors!(nodes[1], 1);
3428         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3429         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3430         check_added_monitors!(nodes[2], 1);
3431         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3432
3433         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3434         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3435         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3436
3437         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3438         check_closed_broadcast!(nodes[2], false);
3439         check_added_monitors!(nodes[2], 1);
3440         let tx = {
3441                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3442                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3443                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3444                 // back to nodes[1] upon timeout otherwise.
3445                 assert_eq!(node_txn.len(), 1);
3446                 node_txn.remove(0)
3447         };
3448
3449         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3450         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3451
3452         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3453         check_closed_broadcast!(nodes[1], false);
3454         check_added_monitors!(nodes[1], 1);
3455
3456         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3457         {
3458                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3459                 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3460                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3461         }
3462         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3463         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3464         assert_eq!(node_txn.len(), 1);
3465         assert_eq!(node_txn[0].input.len(), 1);
3466         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3467         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3468         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3469
3470         check_spends!(node_txn[0], tx);
3471 }
3472
3473 #[test]
3474 fn test_unconf_chan() {
3475         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3476         let chanmon_cfgs = create_chanmon_cfgs(2);
3477         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3478         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3479         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3480         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3481
3482         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3483         assert_eq!(channel_state.by_id.len(), 1);
3484         assert_eq!(channel_state.short_to_id.len(), 1);
3485         mem::drop(channel_state);
3486
3487         let mut headers = Vec::new();
3488         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3489         headers.push(header.clone());
3490         for _i in 2..100 {
3491                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3492                 headers.push(header.clone());
3493         }
3494         let mut height = 99;
3495         while !headers.is_empty() {
3496                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3497                 height -= 1;
3498         }
3499         check_closed_broadcast!(nodes[0], false);
3500         check_added_monitors!(nodes[0], 1);
3501         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3502         assert_eq!(channel_state.by_id.len(), 0);
3503         assert_eq!(channel_state.short_to_id.len(), 0);
3504 }
3505
3506 #[test]
3507 fn test_simple_peer_disconnect() {
3508         // Test that we can reconnect when there are no lost messages
3509         let chanmon_cfgs = create_chanmon_cfgs(3);
3510         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3511         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3512         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3513         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3514         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3515
3516         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3517         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3518         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3519
3520         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3521         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3522         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3523         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3524
3525         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3526         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3527         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3528
3529         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3530         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3531         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3532         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3533
3534         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3535         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3536
3537         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3538         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3539
3540         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3541         {
3542                 let events = nodes[0].node.get_and_clear_pending_events();
3543                 assert_eq!(events.len(), 2);
3544                 match events[0] {
3545                         Event::PaymentSent { payment_preimage } => {
3546                                 assert_eq!(payment_preimage, payment_preimage_3);
3547                         },
3548                         _ => panic!("Unexpected event"),
3549                 }
3550                 match events[1] {
3551                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3552                                 assert_eq!(payment_hash, payment_hash_5);
3553                                 assert!(rejected_by_dest);
3554                         },
3555                         _ => panic!("Unexpected event"),
3556                 }
3557         }
3558
3559         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3560         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3561 }
3562
3563 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3564         // Test that we can reconnect when in-flight HTLC updates get dropped
3565         let chanmon_cfgs = create_chanmon_cfgs(2);
3566         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3567         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3568         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3569         if messages_delivered == 0 {
3570                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3571                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3572         } else {
3573                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3574         }
3575
3576         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3577
3578         let logger = test_utils::TestLogger::new();
3579         let payment_event = {
3580                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3581                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3582                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3583                 check_added_monitors!(nodes[0], 1);
3584
3585                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3586                 assert_eq!(events.len(), 1);
3587                 SendEvent::from_event(events.remove(0))
3588         };
3589         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3590
3591         if messages_delivered < 2 {
3592                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3593         } else {
3594                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3595                 if messages_delivered >= 3 {
3596                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3597                         check_added_monitors!(nodes[1], 1);
3598                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3599
3600                         if messages_delivered >= 4 {
3601                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3602                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3603                                 check_added_monitors!(nodes[0], 1);
3604
3605                                 if messages_delivered >= 5 {
3606                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3607                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3608                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3609                                         check_added_monitors!(nodes[0], 1);
3610
3611                                         if messages_delivered >= 6 {
3612                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3613                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3614                                                 check_added_monitors!(nodes[1], 1);
3615                                         }
3616                                 }
3617                         }
3618                 }
3619         }
3620
3621         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3622         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3623         if messages_delivered < 3 {
3624                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3625                 // received on either side, both sides will need to resend them.
3626                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3627         } else if messages_delivered == 3 {
3628                 // nodes[0] still wants its RAA + commitment_signed
3629                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3630         } else if messages_delivered == 4 {
3631                 // nodes[0] still wants its commitment_signed
3632                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3633         } else if messages_delivered == 5 {
3634                 // nodes[1] still wants its final RAA
3635                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3636         } else if messages_delivered == 6 {
3637                 // Everything was delivered...
3638                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3639         }
3640
3641         let events_1 = nodes[1].node.get_and_clear_pending_events();
3642         assert_eq!(events_1.len(), 1);
3643         match events_1[0] {
3644                 Event::PendingHTLCsForwardable { .. } => { },
3645                 _ => panic!("Unexpected event"),
3646         };
3647
3648         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3649         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3650         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3651
3652         nodes[1].node.process_pending_htlc_forwards();
3653
3654         let events_2 = nodes[1].node.get_and_clear_pending_events();
3655         assert_eq!(events_2.len(), 1);
3656         match events_2[0] {
3657                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3658                         assert_eq!(payment_hash_1, *payment_hash);
3659                         assert_eq!(*payment_secret, None);
3660                         assert_eq!(amt, 1000000);
3661                 },
3662                 _ => panic!("Unexpected event"),
3663         }
3664
3665         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3666         check_added_monitors!(nodes[1], 1);
3667
3668         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3669         assert_eq!(events_3.len(), 1);
3670         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3671                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3672                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3673                         assert!(updates.update_add_htlcs.is_empty());
3674                         assert!(updates.update_fail_htlcs.is_empty());
3675                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3676                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3677                         assert!(updates.update_fee.is_none());
3678                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3679                 },
3680                 _ => panic!("Unexpected event"),
3681         };
3682
3683         if messages_delivered >= 1 {
3684                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3685
3686                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3687                 assert_eq!(events_4.len(), 1);
3688                 match events_4[0] {
3689                         Event::PaymentSent { ref payment_preimage } => {
3690                                 assert_eq!(payment_preimage_1, *payment_preimage);
3691                         },
3692                         _ => panic!("Unexpected event"),
3693                 }
3694
3695                 if messages_delivered >= 2 {
3696                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3697                         check_added_monitors!(nodes[0], 1);
3698                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3699
3700                         if messages_delivered >= 3 {
3701                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3702                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3703                                 check_added_monitors!(nodes[1], 1);
3704
3705                                 if messages_delivered >= 4 {
3706                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3707                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3708                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3709                                         check_added_monitors!(nodes[1], 1);
3710
3711                                         if messages_delivered >= 5 {
3712                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3713                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3714                                                 check_added_monitors!(nodes[0], 1);
3715                                         }
3716                                 }
3717                         }
3718                 }
3719         }
3720
3721         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3722         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3723         if messages_delivered < 2 {
3724                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3725                 //TODO: Deduplicate PaymentSent events, then enable this if:
3726                 //if messages_delivered < 1 {
3727                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3728                         assert_eq!(events_4.len(), 1);
3729                         match events_4[0] {
3730                                 Event::PaymentSent { ref payment_preimage } => {
3731                                         assert_eq!(payment_preimage_1, *payment_preimage);
3732                                 },
3733                                 _ => panic!("Unexpected event"),
3734                         }
3735                 //}
3736         } else if messages_delivered == 2 {
3737                 // nodes[0] still wants its RAA + commitment_signed
3738                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3739         } else if messages_delivered == 3 {
3740                 // nodes[0] still wants its commitment_signed
3741                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3742         } else if messages_delivered == 4 {
3743                 // nodes[1] still wants its final RAA
3744                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3745         } else if messages_delivered == 5 {
3746                 // Everything was delivered...
3747                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3748         }
3749
3750         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3751         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3752         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3753
3754         // Channel should still work fine...
3755         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3756         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV, &logger).unwrap();
3757         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3758         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3759 }
3760
3761 #[test]
3762 fn test_drop_messages_peer_disconnect_a() {
3763         do_test_drop_messages_peer_disconnect(0);
3764         do_test_drop_messages_peer_disconnect(1);
3765         do_test_drop_messages_peer_disconnect(2);
3766         do_test_drop_messages_peer_disconnect(3);
3767 }
3768
3769 #[test]
3770 fn test_drop_messages_peer_disconnect_b() {
3771         do_test_drop_messages_peer_disconnect(4);
3772         do_test_drop_messages_peer_disconnect(5);
3773         do_test_drop_messages_peer_disconnect(6);
3774 }
3775
3776 #[test]
3777 fn test_funding_peer_disconnect() {
3778         // Test that we can lock in our funding tx while disconnected
3779         let chanmon_cfgs = create_chanmon_cfgs(2);
3780         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3781         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3782         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3783         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3784
3785         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3786         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3787
3788         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3789         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3790         assert_eq!(events_1.len(), 1);
3791         match events_1[0] {
3792                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3793                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3794                 },
3795                 _ => panic!("Unexpected event"),
3796         }
3797
3798         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3799
3800         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3801         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3802
3803         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3804         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3805         assert_eq!(events_2.len(), 2);
3806         let funding_locked = match events_2[0] {
3807                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3808                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3809                         msg.clone()
3810                 },
3811                 _ => panic!("Unexpected event"),
3812         };
3813         let bs_announcement_sigs = match events_2[1] {
3814                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3815                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3816                         msg.clone()
3817                 },
3818                 _ => panic!("Unexpected event"),
3819         };
3820
3821         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3822
3823         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3824         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3825         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3826         assert_eq!(events_3.len(), 2);
3827         let as_announcement_sigs = match events_3[0] {
3828                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3829                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3830                         msg.clone()
3831                 },
3832                 _ => panic!("Unexpected event"),
3833         };
3834         let (as_announcement, as_update) = match events_3[1] {
3835                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3836                         (msg.clone(), update_msg.clone())
3837                 },
3838                 _ => panic!("Unexpected event"),
3839         };
3840
3841         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3842         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3843         assert_eq!(events_4.len(), 1);
3844         let (_, bs_update) = match events_4[0] {
3845                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3846                         (msg.clone(), update_msg.clone())
3847                 },
3848                 _ => panic!("Unexpected event"),
3849         };
3850
3851         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3852         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3853         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3854
3855         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3856         let logger = test_utils::TestLogger::new();
3857         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();
3858         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3859         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3860 }
3861
3862 #[test]
3863 fn test_drop_messages_peer_disconnect_dual_htlc() {
3864         // Test that we can handle reconnecting when both sides of a channel have pending
3865         // commitment_updates when we disconnect.
3866         let chanmon_cfgs = create_chanmon_cfgs(2);
3867         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3868         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3869         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3870         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3871         let logger = test_utils::TestLogger::new();
3872
3873         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3874
3875         // Now try to send a second payment which will fail to send
3876         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3877         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3878         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();
3879         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3880         check_added_monitors!(nodes[0], 1);
3881
3882         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3883         assert_eq!(events_1.len(), 1);
3884         match events_1[0] {
3885                 MessageSendEvent::UpdateHTLCs { .. } => {},
3886                 _ => panic!("Unexpected event"),
3887         }
3888
3889         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3890         check_added_monitors!(nodes[1], 1);
3891
3892         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3893         assert_eq!(events_2.len(), 1);
3894         match events_2[0] {
3895                 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 } } => {
3896                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3897                         assert!(update_add_htlcs.is_empty());
3898                         assert_eq!(update_fulfill_htlcs.len(), 1);
3899                         assert!(update_fail_htlcs.is_empty());
3900                         assert!(update_fail_malformed_htlcs.is_empty());
3901                         assert!(update_fee.is_none());
3902
3903                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3904                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3905                         assert_eq!(events_3.len(), 1);
3906                         match events_3[0] {
3907                                 Event::PaymentSent { ref payment_preimage } => {
3908                                         assert_eq!(*payment_preimage, payment_preimage_1);
3909                                 },
3910                                 _ => panic!("Unexpected event"),
3911                         }
3912
3913                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3914                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3915                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3916                         check_added_monitors!(nodes[0], 1);
3917                 },
3918                 _ => panic!("Unexpected event"),
3919         }
3920
3921         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3922         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3923
3924         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3925         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3926         assert_eq!(reestablish_1.len(), 1);
3927         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3928         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3929         assert_eq!(reestablish_2.len(), 1);
3930
3931         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3932         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3933         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3934         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3935
3936         assert!(as_resp.0.is_none());
3937         assert!(bs_resp.0.is_none());
3938
3939         assert!(bs_resp.1.is_none());
3940         assert!(bs_resp.2.is_none());
3941
3942         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3943
3944         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3945         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3946         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3947         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3948         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3949         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3950         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3951         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3952         // No commitment_signed so get_event_msg's assert(len == 1) passes
3953         check_added_monitors!(nodes[1], 1);
3954
3955         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3956         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3957         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3958         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3959         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3960         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3961         assert!(bs_second_commitment_signed.update_fee.is_none());
3962         check_added_monitors!(nodes[1], 1);
3963
3964         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3965         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3966         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3967         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3968         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3969         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3970         assert!(as_commitment_signed.update_fee.is_none());
3971         check_added_monitors!(nodes[0], 1);
3972
3973         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3974         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3975         // No commitment_signed so get_event_msg's assert(len == 1) passes
3976         check_added_monitors!(nodes[0], 1);
3977
3978         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3979         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3980         // No commitment_signed so get_event_msg's assert(len == 1) passes
3981         check_added_monitors!(nodes[1], 1);
3982
3983         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3984         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3985         check_added_monitors!(nodes[1], 1);
3986
3987         expect_pending_htlcs_forwardable!(nodes[1]);
3988
3989         let events_5 = nodes[1].node.get_and_clear_pending_events();
3990         assert_eq!(events_5.len(), 1);
3991         match events_5[0] {
3992                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3993                         assert_eq!(payment_hash_2, *payment_hash);
3994                         assert_eq!(*payment_secret, None);
3995                 },
3996                 _ => panic!("Unexpected event"),
3997         }
3998
3999         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4000         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4001         check_added_monitors!(nodes[0], 1);
4002
4003         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4004 }
4005
4006 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4007         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4008         // to avoid our counterparty failing the channel.
4009         let chanmon_cfgs = create_chanmon_cfgs(2);
4010         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4011         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4012         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4013
4014         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4015         let logger = test_utils::TestLogger::new();
4016
4017         let our_payment_hash = if send_partial_mpp {
4018                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4019                 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();
4020                 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4021                 let payment_secret = PaymentSecret([0xdb; 32]);
4022                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4023                 // indicates there are more HTLCs coming.
4024                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
4025                 check_added_monitors!(nodes[0], 1);
4026                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4027                 assert_eq!(events.len(), 1);
4028                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4029                 // hop should *not* yet generate any PaymentReceived event(s).
4030                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4031                 our_payment_hash
4032         } else {
4033                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4034         };
4035
4036         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4037         nodes[0].block_notifier.block_connected_checked(&header, 101, &[], &[]);
4038         nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
4039         for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4040                 header.prev_blockhash = header.bitcoin_hash();
4041                 nodes[0].block_notifier.block_connected_checked(&header, i, &[], &[]);
4042                 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
4043         }
4044
4045         expect_pending_htlcs_forwardable!(nodes[1]);
4046
4047         check_added_monitors!(nodes[1], 1);
4048         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4049         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4050         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4051         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4052         assert!(htlc_timeout_updates.update_fee.is_none());
4053
4054         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4055         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4056         // 100_000 msat as u64, followed by a height of 123 as u32
4057         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4058         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
4059         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4060 }
4061
4062 #[test]
4063 fn test_htlc_timeout() {
4064         do_test_htlc_timeout(true);
4065         do_test_htlc_timeout(false);
4066 }
4067
4068 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4069         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4070         let chanmon_cfgs = create_chanmon_cfgs(3);
4071         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4072         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4073         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4074         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4075         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4076         let logger = test_utils::TestLogger::new();
4077
4078         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4079         let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4080         {
4081                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4082                 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();
4083                 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4084         }
4085         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4086         check_added_monitors!(nodes[1], 1);
4087
4088         // Now attempt to route a second payment, which should be placed in the holding cell
4089         let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4090         if forwarded_htlc {
4091                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4092                 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();
4093                 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4094                 check_added_monitors!(nodes[0], 1);
4095                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4096                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4097                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4098                 expect_pending_htlcs_forwardable!(nodes[1]);
4099                 check_added_monitors!(nodes[1], 0);
4100         } else {
4101                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4102                 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();
4103                 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4104                 check_added_monitors!(nodes[1], 0);
4105         }
4106
4107         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4108         nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
4109         for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4110                 header.prev_blockhash = header.bitcoin_hash();
4111                 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
4112         }
4113
4114         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4115         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4116
4117         header.prev_blockhash = header.bitcoin_hash();
4118         nodes[1].block_notifier.block_connected_checked(&header, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS, &[], &[]);
4119
4120         if forwarded_htlc {
4121                 expect_pending_htlcs_forwardable!(nodes[1]);
4122                 check_added_monitors!(nodes[1], 1);
4123                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4124                 assert_eq!(fail_commit.len(), 1);
4125                 match fail_commit[0] {
4126                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4127                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4128                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4129                         },
4130                         _ => unreachable!(),
4131                 }
4132                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4133                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4134                         match update {
4135                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4136                                 _ => panic!("Unexpected event"),
4137                         }
4138                 } else {
4139                         panic!("Unexpected event");
4140                 }
4141         } else {
4142                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4143         }
4144 }
4145
4146 #[test]
4147 fn test_holding_cell_htlc_add_timeouts() {
4148         do_test_holding_cell_htlc_add_timeouts(false);
4149         do_test_holding_cell_htlc_add_timeouts(true);
4150 }
4151
4152 #[test]
4153 fn test_invalid_channel_announcement() {
4154         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4155         let secp_ctx = Secp256k1::new();
4156         let chanmon_cfgs = create_chanmon_cfgs(2);
4157         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4158         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4159         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4160
4161         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4162
4163         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4164         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4165         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4166         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4167
4168         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 } );
4169
4170         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4171         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4172
4173         let as_network_key = nodes[0].node.get_our_node_id();
4174         let bs_network_key = nodes[1].node.get_our_node_id();
4175
4176         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4177
4178         let mut chan_announcement;
4179
4180         macro_rules! dummy_unsigned_msg {
4181                 () => {
4182                         msgs::UnsignedChannelAnnouncement {
4183                                 features: ChannelFeatures::known(),
4184                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
4185                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4186                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4187                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4188                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4189                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4190                                 excess_data: Vec::new(),
4191                         };
4192                 }
4193         }
4194
4195         macro_rules! sign_msg {
4196                 ($unsigned_msg: expr) => {
4197                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4198                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
4199                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
4200                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4201                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4202                         chan_announcement = msgs::ChannelAnnouncement {
4203                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4204                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4205                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4206                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4207                                 contents: $unsigned_msg
4208                         }
4209                 }
4210         }
4211
4212         let unsigned_msg = dummy_unsigned_msg!();
4213         sign_msg!(unsigned_msg);
4214         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4215         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 } );
4216
4217         // Configured with Network::Testnet
4218         let mut unsigned_msg = dummy_unsigned_msg!();
4219         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
4220         sign_msg!(unsigned_msg);
4221         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4222
4223         let mut unsigned_msg = dummy_unsigned_msg!();
4224         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4225         sign_msg!(unsigned_msg);
4226         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4227 }
4228
4229 #[test]
4230 fn test_no_txn_manager_serialize_deserialize() {
4231         let chanmon_cfgs = create_chanmon_cfgs(2);
4232         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4233         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4234         let logger: test_utils::TestLogger;
4235         let fee_estimator: test_utils::TestFeeEstimator;
4236         let new_chan_monitor: test_utils::TestChannelMonitor;
4237         let keys_manager: test_utils::TestKeysInterface;
4238         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4239         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4240
4241         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4242
4243         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4244
4245         let nodes_0_serialized = nodes[0].node.encode();
4246         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4247         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4248
4249         logger = test_utils::TestLogger::new();
4250         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4251         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4252         nodes[0].chan_monitor = &new_chan_monitor;
4253         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4254         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4255         assert!(chan_0_monitor_read.is_empty());
4256
4257         let mut nodes_0_read = &nodes_0_serialized[..];
4258         let config = UserConfig::default();
4259         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4260         let (_, nodes_0_deserialized_tmp) = {
4261                 let mut channel_monitors = HashMap::new();
4262                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4263                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4264                         default_config: config,
4265                         keys_manager: &keys_manager,
4266                         fee_estimator: &fee_estimator,
4267                         monitor: nodes[0].chan_monitor,
4268                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4269                         logger: &logger,
4270                         channel_monitors: &mut channel_monitors,
4271                 }).unwrap()
4272         };
4273         nodes_0_deserialized = nodes_0_deserialized_tmp;
4274         assert!(nodes_0_read.is_empty());
4275
4276         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4277         nodes[0].node = &nodes_0_deserialized;
4278         nodes[0].block_notifier.register_listener(nodes[0].node);
4279         assert_eq!(nodes[0].node.list_channels().len(), 1);
4280         check_added_monitors!(nodes[0], 1);
4281
4282         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4283         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4284         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4285         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4286
4287         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4288         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4289         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4290         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4291
4292         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4293         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4294         for node in nodes.iter() {
4295                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4296                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4297                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4298         }
4299
4300         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4301 }
4302
4303 #[test]
4304 fn test_manager_serialize_deserialize_events() {
4305         // This test makes sure the events field in ChannelManager survives de/serialization
4306         let chanmon_cfgs = create_chanmon_cfgs(2);
4307         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4308         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4309         let fee_estimator: test_utils::TestFeeEstimator;
4310         let logger: test_utils::TestLogger;
4311         let new_chan_monitor: test_utils::TestChannelMonitor;
4312         let keys_manager: test_utils::TestKeysInterface;
4313         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4314         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4315
4316         // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4317         let channel_value = 100000;
4318         let push_msat = 10001;
4319         let a_flags = InitFeatures::known();
4320         let b_flags = InitFeatures::known();
4321         let node_a = nodes.pop().unwrap();
4322         let node_b = nodes.pop().unwrap();
4323         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4324         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()));
4325         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()));
4326
4327         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4328
4329         node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4330         check_added_monitors!(node_a, 0);
4331
4332         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()));
4333         {
4334                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
4335                 assert_eq!(added_monitors.len(), 1);
4336                 assert_eq!(added_monitors[0].0, funding_output);
4337                 added_monitors.clear();
4338         }
4339
4340         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()));
4341         {
4342                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
4343                 assert_eq!(added_monitors.len(), 1);
4344                 assert_eq!(added_monitors[0].0, funding_output);
4345                 added_monitors.clear();
4346         }
4347         // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4348
4349         nodes.push(node_a);
4350         nodes.push(node_b);
4351
4352         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4353         let nodes_0_serialized = nodes[0].node.encode();
4354         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4355         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4356
4357         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4358         logger = test_utils::TestLogger::new();
4359         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4360         nodes[0].chan_monitor = &new_chan_monitor;
4361         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4362         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4363         assert!(chan_0_monitor_read.is_empty());
4364
4365         let mut nodes_0_read = &nodes_0_serialized[..];
4366         let config = UserConfig::default();
4367         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4368         let (_, nodes_0_deserialized_tmp) = {
4369                 let mut channel_monitors = HashMap::new();
4370                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4371                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4372                         default_config: config,
4373                         keys_manager: &keys_manager,
4374                         fee_estimator: &fee_estimator,
4375                         monitor: nodes[0].chan_monitor,
4376                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4377                         logger: &logger,
4378                         channel_monitors: &mut channel_monitors,
4379                 }).unwrap()
4380         };
4381         nodes_0_deserialized = nodes_0_deserialized_tmp;
4382         assert!(nodes_0_read.is_empty());
4383
4384         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4385
4386         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4387         nodes[0].node = &nodes_0_deserialized;
4388
4389         // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4390         let events_4 = nodes[0].node.get_and_clear_pending_events();
4391         assert_eq!(events_4.len(), 1);
4392         match events_4[0] {
4393                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4394                         assert_eq!(user_channel_id, 42);
4395                         assert_eq!(*funding_txo, funding_output);
4396                 },
4397                 _ => panic!("Unexpected event"),
4398         };
4399
4400         // Make sure the channel is functioning as though the de/serialization never happened
4401         nodes[0].block_notifier.register_listener(nodes[0].node);
4402         assert_eq!(nodes[0].node.list_channels().len(), 1);
4403         check_added_monitors!(nodes[0], 1);
4404
4405         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4406         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4407         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4408         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4409
4410         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4411         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4412         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4413         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4414
4415         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4416         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4417         for node in nodes.iter() {
4418                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4419                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4420                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4421         }
4422
4423         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4424 }
4425
4426 #[test]
4427 fn test_simple_manager_serialize_deserialize() {
4428         let chanmon_cfgs = create_chanmon_cfgs(2);
4429         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4430         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4431         let logger: test_utils::TestLogger;
4432         let fee_estimator: test_utils::TestFeeEstimator;
4433         let new_chan_monitor: test_utils::TestChannelMonitor;
4434         let keys_manager: test_utils::TestKeysInterface;
4435         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4436         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4437         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4438
4439         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4440         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4441
4442         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4443
4444         let nodes_0_serialized = nodes[0].node.encode();
4445         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4446         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4447
4448         logger = test_utils::TestLogger::new();
4449         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4450         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4451         nodes[0].chan_monitor = &new_chan_monitor;
4452         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4453         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4454         assert!(chan_0_monitor_read.is_empty());
4455
4456         let mut nodes_0_read = &nodes_0_serialized[..];
4457         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4458         let (_, nodes_0_deserialized_tmp) = {
4459                 let mut channel_monitors = HashMap::new();
4460                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4461                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4462                         default_config: UserConfig::default(),
4463                         keys_manager: &keys_manager,
4464                         fee_estimator: &fee_estimator,
4465                         monitor: nodes[0].chan_monitor,
4466                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4467                         logger: &logger,
4468                         channel_monitors: &mut channel_monitors,
4469                 }).unwrap()
4470         };
4471         nodes_0_deserialized = nodes_0_deserialized_tmp;
4472         assert!(nodes_0_read.is_empty());
4473
4474         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4475         nodes[0].node = &nodes_0_deserialized;
4476         check_added_monitors!(nodes[0], 1);
4477
4478         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4479
4480         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4481         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4482 }
4483
4484 #[test]
4485 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4486         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4487         let chanmon_cfgs = create_chanmon_cfgs(4);
4488         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4489         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4490         let logger: test_utils::TestLogger;
4491         let fee_estimator: test_utils::TestFeeEstimator;
4492         let new_chan_monitor: test_utils::TestChannelMonitor;
4493         let keys_manager: test_utils::TestKeysInterface;
4494         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4495         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4496         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4497         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4498         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4499
4500         let mut node_0_stale_monitors_serialized = Vec::new();
4501         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4502                 let mut writer = test_utils::TestVecWriter(Vec::new());
4503                 monitor.1.write_for_disk(&mut writer).unwrap();
4504                 node_0_stale_monitors_serialized.push(writer.0);
4505         }
4506
4507         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4508
4509         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4510         let nodes_0_serialized = nodes[0].node.encode();
4511
4512         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4513         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4514         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4515         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4516
4517         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4518         // nodes[3])
4519         let mut node_0_monitors_serialized = Vec::new();
4520         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4521                 let mut writer = test_utils::TestVecWriter(Vec::new());
4522                 monitor.1.write_for_disk(&mut writer).unwrap();
4523                 node_0_monitors_serialized.push(writer.0);
4524         }
4525
4526         logger = test_utils::TestLogger::new();
4527         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4528         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4529         nodes[0].chan_monitor = &new_chan_monitor;
4530
4531         let mut node_0_stale_monitors = Vec::new();
4532         for serialized in node_0_stale_monitors_serialized.iter() {
4533                 let mut read = &serialized[..];
4534                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4535                 assert!(read.is_empty());
4536                 node_0_stale_monitors.push(monitor);
4537         }
4538
4539         let mut node_0_monitors = Vec::new();
4540         for serialized in node_0_monitors_serialized.iter() {
4541                 let mut read = &serialized[..];
4542                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4543                 assert!(read.is_empty());
4544                 node_0_monitors.push(monitor);
4545         }
4546
4547         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4548
4549         let mut nodes_0_read = &nodes_0_serialized[..];
4550         if let Err(msgs::DecodeError::InvalidValue) =
4551                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4552                 default_config: UserConfig::default(),
4553                 keys_manager: &keys_manager,
4554                 fee_estimator: &fee_estimator,
4555                 monitor: nodes[0].chan_monitor,
4556                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4557                 logger: &logger,
4558                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4559         }) { } else {
4560                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4561         };
4562
4563         let mut nodes_0_read = &nodes_0_serialized[..];
4564         let (_, nodes_0_deserialized_tmp) =
4565                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4566                 default_config: UserConfig::default(),
4567                 keys_manager: &keys_manager,
4568                 fee_estimator: &fee_estimator,
4569                 monitor: nodes[0].chan_monitor,
4570                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4571                 logger: &logger,
4572                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4573         }).unwrap();
4574         nodes_0_deserialized = nodes_0_deserialized_tmp;
4575         assert!(nodes_0_read.is_empty());
4576
4577         { // Channel close should result in a commitment tx and an HTLC tx
4578                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4579                 assert_eq!(txn.len(), 2);
4580                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4581                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4582         }
4583
4584         for monitor in node_0_monitors.drain(..) {
4585                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().0, monitor).is_ok());
4586                 check_added_monitors!(nodes[0], 1);
4587         }
4588         nodes[0].node = &nodes_0_deserialized;
4589
4590         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4591         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4592         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4593         //... and we can even still claim the payment!
4594         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4595
4596         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4597         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4598         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4599         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4600         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4601         assert_eq!(msg_events.len(), 1);
4602         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4603                 match action {
4604                         &ErrorAction::SendErrorMessage { ref msg } => {
4605                                 assert_eq!(msg.channel_id, channel_id);
4606                         },
4607                         _ => panic!("Unexpected event!"),
4608                 }
4609         }
4610 }
4611
4612 macro_rules! check_spendable_outputs {
4613         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4614                 {
4615                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
4616                         let mut txn = Vec::new();
4617                         for event in events {
4618                                 match event {
4619                                         Event::SpendableOutputs { ref outputs } => {
4620                                                 for outp in outputs {
4621                                                         match *outp {
4622                                                                 SpendableOutputDescriptor::StaticOutputRemotePayment { ref outpoint, ref output, ref key_derivation_params } => {
4623                                                                         let input = TxIn {
4624                                                                                 previous_output: outpoint.clone(),
4625                                                                                 script_sig: Script::new(),
4626                                                                                 sequence: 0,
4627                                                                                 witness: Vec::new(),
4628                                                                         };
4629                                                                         let outp = TxOut {
4630                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4631                                                                                 value: output.value,
4632                                                                         };
4633                                                                         let mut spend_tx = Transaction {
4634                                                                                 version: 2,
4635                                                                                 lock_time: 0,
4636                                                                                 input: vec![input],
4637                                                                                 output: vec![outp],
4638                                                                         };
4639                                                                         let secp_ctx = Secp256k1::new();
4640                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4641                                                                         let remotepubkey = keys.pubkeys().payment_point;
4642                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4643                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4644                                                                         let remotesig = secp_ctx.sign(&sighash, &keys.inner.payment_key);
4645                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4646                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4647                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4648                                                                         txn.push(spend_tx);
4649                                                                 },
4650                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref per_commitment_point, ref to_self_delay, ref output, ref key_derivation_params, ref remote_revocation_pubkey } => {
4651                                                                         let input = TxIn {
4652                                                                                 previous_output: outpoint.clone(),
4653                                                                                 script_sig: Script::new(),
4654                                                                                 sequence: *to_self_delay as u32,
4655                                                                                 witness: Vec::new(),
4656                                                                         };
4657                                                                         let outp = TxOut {
4658                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4659                                                                                 value: output.value,
4660                                                                         };
4661                                                                         let mut spend_tx = Transaction {
4662                                                                                 version: 2,
4663                                                                                 lock_time: 0,
4664                                                                                 input: vec![input],
4665                                                                                 output: vec![outp],
4666                                                                         };
4667                                                                         let secp_ctx = Secp256k1::new();
4668                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4669                                                                         if let Ok(delayed_payment_key) = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &keys.inner.delayed_payment_base_key) {
4670
4671                                                                                 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
4672                                                                                 let witness_script = chan_utils::get_revokeable_redeemscript(remote_revocation_pubkey, *to_self_delay, &delayed_payment_pubkey);
4673                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4674                                                                                 let local_delayedsig = secp_ctx.sign(&sighash, &delayed_payment_key);
4675                                                                                 spend_tx.input[0].witness.push(local_delayedsig.serialize_der().to_vec());
4676                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4677                                                                                 spend_tx.input[0].witness.push(vec!()); //MINIMALIF
4678                                                                                 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4679                                                                         } else { panic!() }
4680                                                                         txn.push(spend_tx);
4681                                                                 },
4682                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4683                                                                         let secp_ctx = Secp256k1::new();
4684                                                                         let input = TxIn {
4685                                                                                 previous_output: outpoint.clone(),
4686                                                                                 script_sig: Script::new(),
4687                                                                                 sequence: 0,
4688                                                                                 witness: Vec::new(),
4689                                                                         };
4690                                                                         let outp = TxOut {
4691                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4692                                                                                 value: output.value,
4693                                                                         };
4694                                                                         let mut spend_tx = Transaction {
4695                                                                                 version: 2,
4696                                                                                 lock_time: 0,
4697                                                                                 input: vec![input],
4698                                                                                 output: vec![outp.clone()],
4699                                                                         };
4700                                                                         let secret = {
4701                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4702                                                                                         Ok(master_key) => {
4703                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4704                                                                                                         Ok(key) => key,
4705                                                                                                         Err(_) => panic!("Your RNG is busted"),
4706                                                                                                 }
4707                                                                                         }
4708                                                                                         Err(_) => panic!("Your rng is busted"),
4709                                                                                 }
4710                                                                         };
4711                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4712                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4713                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4714                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4715                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4716                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4717                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4718                                                                         txn.push(spend_tx);
4719                                                                 },
4720                                                         }
4721                                                 }
4722                                         },
4723                                         _ => panic!("Unexpected event"),
4724                                 };
4725                         }
4726                         txn
4727                 }
4728         }
4729 }
4730
4731 #[test]
4732 fn test_claim_sizeable_push_msat() {
4733         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4734         let chanmon_cfgs = create_chanmon_cfgs(2);
4735         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4736         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4737         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4738
4739         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4740         nodes[1].node.force_close_channel(&chan.2);
4741         check_closed_broadcast!(nodes[1], false);
4742         check_added_monitors!(nodes[1], 1);
4743         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4744         assert_eq!(node_txn.len(), 1);
4745         check_spends!(node_txn[0], chan.3);
4746         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
4747
4748         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4749         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4750         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4751
4752         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4753         assert_eq!(spend_txn.len(), 1);
4754         check_spends!(spend_txn[0], node_txn[0]);
4755 }
4756
4757 #[test]
4758 fn test_claim_on_remote_sizeable_push_msat() {
4759         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4760         // to_remote output is encumbered by a P2WPKH
4761         let chanmon_cfgs = create_chanmon_cfgs(2);
4762         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4763         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4764         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4765
4766         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4767         nodes[0].node.force_close_channel(&chan.2);
4768         check_closed_broadcast!(nodes[0], false);
4769         check_added_monitors!(nodes[0], 1);
4770
4771         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4772         assert_eq!(node_txn.len(), 1);
4773         check_spends!(node_txn[0], chan.3);
4774         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
4775
4776         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4777         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4778         check_closed_broadcast!(nodes[1], false);
4779         check_added_monitors!(nodes[1], 1);
4780         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4781
4782         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4783         assert_eq!(spend_txn.len(), 2);
4784         assert_eq!(spend_txn[0], spend_txn[1]);
4785         check_spends!(spend_txn[0], node_txn[0]);
4786 }
4787
4788 #[test]
4789 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4790         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4791         // to_remote output is encumbered by a P2WPKH
4792
4793         let chanmon_cfgs = create_chanmon_cfgs(2);
4794         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4795         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4796         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4797
4798         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4799         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4800         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4801         assert_eq!(revoked_local_txn[0].input.len(), 1);
4802         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4803
4804         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4805         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4806         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4807         check_closed_broadcast!(nodes[1], false);
4808         check_added_monitors!(nodes[1], 1);
4809
4810         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4811         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4812         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4813         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4814
4815         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4816         assert_eq!(spend_txn.len(), 3);
4817         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4818         check_spends!(spend_txn[0], revoked_local_txn[0]);
4819         check_spends!(spend_txn[2], node_txn[0]);
4820 }
4821
4822 #[test]
4823 fn test_static_spendable_outputs_preimage_tx() {
4824         let chanmon_cfgs = create_chanmon_cfgs(2);
4825         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4826         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4827         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4828
4829         // Create some initial channels
4830         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4831
4832         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4833
4834         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4835         assert_eq!(commitment_tx[0].input.len(), 1);
4836         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4837
4838         // Settle A's commitment tx on B's chain
4839         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4840         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4841         check_added_monitors!(nodes[1], 1);
4842         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4843         check_added_monitors!(nodes[1], 1);
4844         let events = nodes[1].node.get_and_clear_pending_msg_events();
4845         match events[0] {
4846                 MessageSendEvent::UpdateHTLCs { .. } => {},
4847                 _ => panic!("Unexpected event"),
4848         }
4849         match events[1] {
4850                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4851                 _ => panic!("Unexepected event"),
4852         }
4853
4854         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4855         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4856         assert_eq!(node_txn.len(), 3);
4857         check_spends!(node_txn[0], commitment_tx[0]);
4858         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4859         check_spends!(node_txn[1], chan_1.3);
4860         check_spends!(node_txn[2], node_txn[1]);
4861
4862         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4863         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4864         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4865
4866         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4867         assert_eq!(spend_txn.len(), 1);
4868         check_spends!(spend_txn[0], node_txn[0]);
4869 }
4870
4871 #[test]
4872 fn test_static_spendable_outputs_timeout_tx() {
4873         let chanmon_cfgs = create_chanmon_cfgs(2);
4874         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4875         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4876         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4877
4878         // Create some initial channels
4879         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4880
4881         // Rebalance the network a bit by relaying one payment through all the channels ...
4882         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4883
4884         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4885
4886         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4887         assert_eq!(commitment_tx[0].input.len(), 1);
4888         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4889
4890         // Settle A's commitment tx on B' chain
4891         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4892         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4893         check_added_monitors!(nodes[1], 1);
4894         let events = nodes[1].node.get_and_clear_pending_msg_events();
4895         match events[0] {
4896                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4897                 _ => panic!("Unexpected event"),
4898         }
4899
4900         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4901         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4902         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4903         check_spends!(node_txn[0],  commitment_tx[0].clone());
4904         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4905         check_spends!(node_txn[1], chan_1.3.clone());
4906         check_spends!(node_txn[2], node_txn[1]);
4907
4908         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4909         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4910         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4911         expect_payment_failed!(nodes[1], our_payment_hash, true);
4912
4913         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4914         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4915         check_spends!(spend_txn[2], node_txn[0].clone());
4916 }
4917
4918 #[test]
4919 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4920         let chanmon_cfgs = create_chanmon_cfgs(2);
4921         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4922         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4923         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4924
4925         // Create some initial channels
4926         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4927
4928         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4929         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4930         assert_eq!(revoked_local_txn[0].input.len(), 1);
4931         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4932
4933         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4934
4935         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4936         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4937         check_closed_broadcast!(nodes[1], false);
4938         check_added_monitors!(nodes[1], 1);
4939
4940         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4941         assert_eq!(node_txn.len(), 2);
4942         assert_eq!(node_txn[0].input.len(), 2);
4943         check_spends!(node_txn[0], revoked_local_txn[0]);
4944
4945         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4946         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4947         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4948
4949         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4950         assert_eq!(spend_txn.len(), 1);
4951         check_spends!(spend_txn[0], node_txn[0]);
4952 }
4953
4954 #[test]
4955 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4956         let chanmon_cfgs = create_chanmon_cfgs(2);
4957         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4958         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4959         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4960
4961         // Create some initial channels
4962         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4963
4964         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4965         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4966         assert_eq!(revoked_local_txn[0].input.len(), 1);
4967         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4968
4969         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4970
4971         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4972         // A will generate HTLC-Timeout from revoked commitment tx
4973         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4974         check_closed_broadcast!(nodes[0], false);
4975         check_added_monitors!(nodes[0], 1);
4976
4977         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4978         assert_eq!(revoked_htlc_txn.len(), 2);
4979         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4980         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4981         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4982         check_spends!(revoked_htlc_txn[1], chan_1.3);
4983
4984         // B will generate justice tx from A's revoked commitment/HTLC tx
4985         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4986         check_closed_broadcast!(nodes[1], false);
4987         check_added_monitors!(nodes[1], 1);
4988
4989         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4990         assert_eq!(node_txn.len(), 4); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-timeout, adjusted justice tx, ChannelManager: local commitment tx
4991         assert_eq!(node_txn[0].input.len(), 2);
4992         check_spends!(node_txn[0], revoked_local_txn[0]);
4993         check_spends!(node_txn[1], chan_1.3);
4994         assert_eq!(node_txn[2].input.len(), 1);
4995         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4996         assert_eq!(node_txn[3].input.len(), 1);
4997         check_spends!(node_txn[3], revoked_local_txn[0]);
4998
4999         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5000         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5001         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5002
5003         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5004         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5005         assert_eq!(spend_txn.len(), 2);
5006         check_spends!(spend_txn[0], node_txn[0]);
5007         check_spends!(spend_txn[1], node_txn[2]);
5008 }
5009
5010 #[test]
5011 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5012         let chanmon_cfgs = create_chanmon_cfgs(2);
5013         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5014         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5015         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5016
5017         // Create some initial channels
5018         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5019
5020         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5021         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5022         assert_eq!(revoked_local_txn[0].input.len(), 1);
5023         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5024
5025         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 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         nodes[1].block_notifier.block_connected(&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         // A will generate justice tx from B's revoked commitment/HTLC tx
5040         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5041         check_closed_broadcast!(nodes[0], false);
5042         check_added_monitors!(nodes[0], 1);
5043
5044         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5045         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5046         assert_eq!(node_txn[2].input.len(), 1);
5047         check_spends!(node_txn[2], revoked_htlc_txn[0]);
5048
5049         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5050         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5051         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5052
5053         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5054         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5055         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
5056         assert_eq!(spend_txn[0], spend_txn[1]);
5057         assert_eq!(spend_txn[0], spend_txn[2]);
5058         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5059         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
5060         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
5061 }
5062
5063 #[test]
5064 fn test_onchain_to_onchain_claim() {
5065         // Test that in case of channel closure, we detect the state of output thanks to
5066         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
5067         // First, have C claim an HTLC against its own latest commitment transaction.
5068         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5069         // channel.
5070         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5071         // gets broadcast.
5072
5073         let chanmon_cfgs = create_chanmon_cfgs(3);
5074         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5075         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5076         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5077
5078         // Create some initial channels
5079         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5080         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5081
5082         // Rebalance the network a bit by relaying one payment through all the channels ...
5083         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5084         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5085
5086         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5087         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5088         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5089         check_spends!(commitment_tx[0], chan_2.3);
5090         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5091         check_added_monitors!(nodes[2], 1);
5092         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5093         assert!(updates.update_add_htlcs.is_empty());
5094         assert!(updates.update_fail_htlcs.is_empty());
5095         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5096         assert!(updates.update_fail_malformed_htlcs.is_empty());
5097
5098         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5099         check_closed_broadcast!(nodes[2], false);
5100         check_added_monitors!(nodes[2], 1);
5101
5102         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5103         assert_eq!(c_txn.len(), 3);
5104         assert_eq!(c_txn[0], c_txn[2]);
5105         assert_eq!(commitment_tx[0], c_txn[1]);
5106         check_spends!(c_txn[1], chan_2.3);
5107         check_spends!(c_txn[2], c_txn[1]);
5108         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5109         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5110         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5111         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5112
5113         // 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
5114         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5115         {
5116                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5117                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5118                 assert_eq!(b_txn.len(), 3);
5119                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5120                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5121                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5122                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5123                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5124                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
5125                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5126                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5127                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5128                 b_txn.clear();
5129         }
5130         check_added_monitors!(nodes[1], 1);
5131         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5132         check_added_monitors!(nodes[1], 1);
5133         match msg_events[0] {
5134                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
5135                 _ => panic!("Unexpected event"),
5136         }
5137         match msg_events[1] {
5138                 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, .. } } => {
5139                         assert!(update_add_htlcs.is_empty());
5140                         assert!(update_fail_htlcs.is_empty());
5141                         assert_eq!(update_fulfill_htlcs.len(), 1);
5142                         assert!(update_fail_malformed_htlcs.is_empty());
5143                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5144                 },
5145                 _ => panic!("Unexpected event"),
5146         };
5147         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5148         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5149         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5150         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5151         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5152         assert_eq!(b_txn.len(), 3);
5153         check_spends!(b_txn[1], chan_1.3);
5154         check_spends!(b_txn[2], b_txn[1]);
5155         check_spends!(b_txn[0], commitment_tx[0]);
5156         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5157         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5158         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5159
5160         check_closed_broadcast!(nodes[1], false);
5161         check_added_monitors!(nodes[1], 1);
5162 }
5163
5164 #[test]
5165 fn test_duplicate_payment_hash_one_failure_one_success() {
5166         // Topology : A --> B --> C
5167         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5168         let chanmon_cfgs = create_chanmon_cfgs(3);
5169         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5170         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5171         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5172
5173         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5174         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5175
5176         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5177         *nodes[0].network_payment_count.borrow_mut() -= 1;
5178         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5179
5180         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5181         assert_eq!(commitment_txn[0].input.len(), 1);
5182         check_spends!(commitment_txn[0], chan_2.3);
5183
5184         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5185         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5186         check_closed_broadcast!(nodes[1], false);
5187         check_added_monitors!(nodes[1], 1);
5188
5189         let htlc_timeout_tx;
5190         { // Extract one of the two HTLC-Timeout transaction
5191                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5192                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5193                 assert_eq!(node_txn.len(), 5);
5194                 check_spends!(node_txn[0], commitment_txn[0]);
5195                 assert_eq!(node_txn[0].input.len(), 1);
5196                 check_spends!(node_txn[1], commitment_txn[0]);
5197                 assert_eq!(node_txn[1].input.len(), 1);
5198                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5199                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5200                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5201                 check_spends!(node_txn[2], chan_2.3);
5202                 check_spends!(node_txn[3], node_txn[2]);
5203                 check_spends!(node_txn[4], node_txn[2]);
5204                 htlc_timeout_tx = node_txn[1].clone();
5205         }
5206
5207         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5208         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5209         check_added_monitors!(nodes[2], 3);
5210         let events = nodes[2].node.get_and_clear_pending_msg_events();
5211         match events[0] {
5212                 MessageSendEvent::UpdateHTLCs { .. } => {},
5213                 _ => panic!("Unexpected event"),
5214         }
5215         match events[1] {
5216                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5217                 _ => panic!("Unexepected event"),
5218         }
5219         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5220         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)
5221         check_spends!(htlc_success_txn[2], chan_2.3);
5222         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5223         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5224         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5225         assert_eq!(htlc_success_txn[0].input.len(), 1);
5226         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5227         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5228         assert_eq!(htlc_success_txn[1].input.len(), 1);
5229         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5230         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5231         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5232         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5233
5234         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5235         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
5236         expect_pending_htlcs_forwardable!(nodes[1]);
5237         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5238         assert!(htlc_updates.update_add_htlcs.is_empty());
5239         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5240         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5241         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5242         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5243         check_added_monitors!(nodes[1], 1);
5244
5245         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5246         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5247         {
5248                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5249                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5250                 assert_eq!(events.len(), 1);
5251                 match events[0] {
5252                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5253                         },
5254                         _ => { panic!("Unexpected event"); }
5255                 }
5256         }
5257         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5258
5259         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5260         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5261         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5262         assert!(updates.update_add_htlcs.is_empty());
5263         assert!(updates.update_fail_htlcs.is_empty());
5264         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5265         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5266         assert!(updates.update_fail_malformed_htlcs.is_empty());
5267         check_added_monitors!(nodes[1], 1);
5268
5269         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5270         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5271
5272         let events = nodes[0].node.get_and_clear_pending_events();
5273         match events[0] {
5274                 Event::PaymentSent { ref payment_preimage } => {
5275                         assert_eq!(*payment_preimage, our_payment_preimage);
5276                 }
5277                 _ => panic!("Unexpected event"),
5278         }
5279 }
5280
5281 #[test]
5282 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5283         let chanmon_cfgs = create_chanmon_cfgs(2);
5284         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5285         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5286         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5287
5288         // Create some initial channels
5289         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5290
5291         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5292         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5293         assert_eq!(local_txn[0].input.len(), 1);
5294         check_spends!(local_txn[0], chan_1.3);
5295
5296         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5297         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5298         check_added_monitors!(nodes[1], 1);
5299         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5300         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5301         check_added_monitors!(nodes[1], 1);
5302         let events = nodes[1].node.get_and_clear_pending_msg_events();
5303         match events[0] {
5304                 MessageSendEvent::UpdateHTLCs { .. } => {},
5305                 _ => panic!("Unexpected event"),
5306         }
5307         match events[1] {
5308                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5309                 _ => panic!("Unexepected event"),
5310         }
5311         let node_txn = {
5312                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5313                 assert_eq!(node_txn[0].input.len(), 1);
5314                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5315                 check_spends!(node_txn[0], local_txn[0]);
5316                 vec![node_txn[0].clone(), node_txn[2].clone()]
5317         };
5318
5319         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5320         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
5321         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5322
5323         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5324         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5325         assert_eq!(spend_txn.len(), 2);
5326         check_spends!(spend_txn[0], node_txn[0]);
5327         check_spends!(spend_txn[1], node_txn[1]);
5328 }
5329
5330 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5331         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5332         // unrevoked commitment transaction.
5333         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5334         // a remote RAA before they could be failed backwards (and combinations thereof).
5335         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5336         // use the same payment hashes.
5337         // Thus, we use a six-node network:
5338         //
5339         // A \         / E
5340         //    - C - D -
5341         // B /         \ F
5342         // And test where C fails back to A/B when D announces its latest commitment transaction
5343         let chanmon_cfgs = create_chanmon_cfgs(6);
5344         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5345         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5346         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5347         let logger = test_utils::TestLogger::new();
5348
5349         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5350         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5351         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5352         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5353         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5354
5355         // Rebalance and check output sanity...
5356         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5357         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5358         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5359
5360         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5361         // 0th HTLC:
5362         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
5363         // 1st HTLC:
5364         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
5365         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5366         let our_node_id = &nodes[1].node.get_our_node_id();
5367         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();
5368         // 2nd HTLC:
5369         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
5370         // 3rd HTLC:
5371         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
5372         // 4th HTLC:
5373         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5374         // 5th HTLC:
5375         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5376         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();
5377         // 6th HTLC:
5378         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5379         // 7th HTLC:
5380         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5381
5382         // 8th HTLC:
5383         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5384         // 9th HTLC:
5385         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();
5386         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
5387
5388         // 10th HTLC:
5389         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
5390         // 11th HTLC:
5391         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();
5392         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5393
5394         // Double-check that six of the new HTLC were added
5395         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5396         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5397         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5398         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5399
5400         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5401         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5402         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5403         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5404         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5405         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5406         check_added_monitors!(nodes[4], 0);
5407         expect_pending_htlcs_forwardable!(nodes[4]);
5408         check_added_monitors!(nodes[4], 1);
5409
5410         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5411         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5412         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5413         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5414         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5415         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5416
5417         // Fail 3rd below-dust and 7th above-dust HTLCs
5418         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5419         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5420         check_added_monitors!(nodes[5], 0);
5421         expect_pending_htlcs_forwardable!(nodes[5]);
5422         check_added_monitors!(nodes[5], 1);
5423
5424         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5425         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5426         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5427         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5428
5429         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5430
5431         expect_pending_htlcs_forwardable!(nodes[3]);
5432         check_added_monitors!(nodes[3], 1);
5433         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5434         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5435         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5436         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5437         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5438         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5439         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5440         if deliver_last_raa {
5441                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5442         } else {
5443                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5444         }
5445
5446         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5447         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5448         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5449         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5450         //
5451         // We now broadcast the latest commitment transaction, which *should* result in failures for
5452         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5453         // the non-broadcast above-dust HTLCs.
5454         //
5455         // Alternatively, we may broadcast the previous commitment transaction, which should only
5456         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5457         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5458
5459         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5460         if announce_latest {
5461                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5462         } else {
5463                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5464         }
5465         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
5466         check_closed_broadcast!(nodes[2], false);
5467         expect_pending_htlcs_forwardable!(nodes[2]);
5468         check_added_monitors!(nodes[2], 3);
5469
5470         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5471         assert_eq!(cs_msgs.len(), 2);
5472         let mut a_done = false;
5473         for msg in cs_msgs {
5474                 match msg {
5475                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5476                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5477                                 // should be failed-backwards here.
5478                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5479                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5480                                         for htlc in &updates.update_fail_htlcs {
5481                                                 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 });
5482                                         }
5483                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5484                                         assert!(!a_done);
5485                                         a_done = true;
5486                                         &nodes[0]
5487                                 } else {
5488                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5489                                         for htlc in &updates.update_fail_htlcs {
5490                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5491                                         }
5492                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5493                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5494                                         &nodes[1]
5495                                 };
5496                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5497                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5498                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5499                                 if announce_latest {
5500                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5501                                         if *node_id == nodes[0].node.get_our_node_id() {
5502                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5503                                         }
5504                                 }
5505                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5506                         },
5507                         _ => panic!("Unexpected event"),
5508                 }
5509         }
5510
5511         let as_events = nodes[0].node.get_and_clear_pending_events();
5512         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5513         let mut as_failds = HashSet::new();
5514         for event in as_events.iter() {
5515                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5516                         assert!(as_failds.insert(*payment_hash));
5517                         if *payment_hash != payment_hash_2 {
5518                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5519                         } else {
5520                                 assert!(!rejected_by_dest);
5521                         }
5522                 } else { panic!("Unexpected event"); }
5523         }
5524         assert!(as_failds.contains(&payment_hash_1));
5525         assert!(as_failds.contains(&payment_hash_2));
5526         if announce_latest {
5527                 assert!(as_failds.contains(&payment_hash_3));
5528                 assert!(as_failds.contains(&payment_hash_5));
5529         }
5530         assert!(as_failds.contains(&payment_hash_6));
5531
5532         let bs_events = nodes[1].node.get_and_clear_pending_events();
5533         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5534         let mut bs_failds = HashSet::new();
5535         for event in bs_events.iter() {
5536                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5537                         assert!(bs_failds.insert(*payment_hash));
5538                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5539                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5540                         } else {
5541                                 assert!(!rejected_by_dest);
5542                         }
5543                 } else { panic!("Unexpected event"); }
5544         }
5545         assert!(bs_failds.contains(&payment_hash_1));
5546         assert!(bs_failds.contains(&payment_hash_2));
5547         if announce_latest {
5548                 assert!(bs_failds.contains(&payment_hash_4));
5549         }
5550         assert!(bs_failds.contains(&payment_hash_5));
5551
5552         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5553         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5554         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5555         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5556         // PaymentFailureNetworkUpdates.
5557         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5558         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5559         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5560         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5561         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5562                 match event {
5563                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5564                         _ => panic!("Unexpected event"),
5565                 }
5566         }
5567 }
5568
5569 #[test]
5570 fn test_fail_backwards_latest_remote_announce_a() {
5571         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5572 }
5573
5574 #[test]
5575 fn test_fail_backwards_latest_remote_announce_b() {
5576         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5577 }
5578
5579 #[test]
5580 fn test_fail_backwards_previous_remote_announce() {
5581         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5582         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5583         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5584 }
5585
5586 #[test]
5587 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5588         let chanmon_cfgs = create_chanmon_cfgs(2);
5589         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5590         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5591         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5592
5593         // Create some initial channels
5594         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5595
5596         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5597         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5598         assert_eq!(local_txn[0].input.len(), 1);
5599         check_spends!(local_txn[0], chan_1.3);
5600
5601         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5602         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5603         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5604         check_closed_broadcast!(nodes[0], false);
5605         check_added_monitors!(nodes[0], 1);
5606
5607         let htlc_timeout = {
5608                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5609                 assert_eq!(node_txn[0].input.len(), 1);
5610                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5611                 check_spends!(node_txn[0], local_txn[0]);
5612                 node_txn[0].clone()
5613         };
5614
5615         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5616         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5617         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5618         expect_payment_failed!(nodes[0], our_payment_hash, true);
5619
5620         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5621         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5622         assert_eq!(spend_txn.len(), 3);
5623         assert_eq!(spend_txn[0], spend_txn[1]);
5624         check_spends!(spend_txn[0], local_txn[0]);
5625         check_spends!(spend_txn[2], htlc_timeout);
5626 }
5627
5628 #[test]
5629 fn test_key_derivation_params() {
5630         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5631         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5632         // let us re-derive the channel key set to then derive a delayed_payment_key.
5633
5634         let chanmon_cfgs = create_chanmon_cfgs(3);
5635
5636         // We manually create the node configuration to backup the seed.
5637         let seed = [42; 32];
5638         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5639         let chan_monitor = test_utils::TestChannelMonitor::new(&chanmon_cfgs[0].chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator);
5640         let node = NodeCfg { chain_monitor: &chanmon_cfgs[0].chain_monitor, logger: &chanmon_cfgs[0].logger, tx_broadcaster: &chanmon_cfgs[0].tx_broadcaster, fee_estimator: &chanmon_cfgs[0].fee_estimator, chan_monitor, keys_manager, node_seed: seed };
5641         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5642         node_cfgs.remove(0);
5643         node_cfgs.insert(0, node);
5644
5645         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5646         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5647
5648         // Create some initial channels
5649         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5650         // for node 0
5651         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5652         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5653         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5654
5655         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5656         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5657         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5658         assert_eq!(local_txn_1[0].input.len(), 1);
5659         check_spends!(local_txn_1[0], chan_1.3);
5660
5661         // We check funding pubkey are unique
5662         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]));
5663         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]));
5664         if from_0_funding_key_0 == from_1_funding_key_0
5665             || from_0_funding_key_0 == from_1_funding_key_1
5666             || from_0_funding_key_1 == from_1_funding_key_0
5667             || from_0_funding_key_1 == from_1_funding_key_1 {
5668                 panic!("Funding pubkeys aren't unique");
5669         }
5670
5671         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5672         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5673         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5674         check_closed_broadcast!(nodes[0], false);
5675         check_added_monitors!(nodes[0], 1);
5676
5677         let htlc_timeout = {
5678                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5679                 assert_eq!(node_txn[0].input.len(), 1);
5680                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5681                 check_spends!(node_txn[0], local_txn_1[0]);
5682                 node_txn[0].clone()
5683         };
5684
5685         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5686         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5687         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5688         expect_payment_failed!(nodes[0], our_payment_hash, true);
5689
5690         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5691         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5692         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5693         assert_eq!(spend_txn.len(), 3);
5694         assert_eq!(spend_txn[0], spend_txn[1]);
5695         check_spends!(spend_txn[0], local_txn_1[0]);
5696         check_spends!(spend_txn[2], htlc_timeout);
5697 }
5698
5699 #[test]
5700 fn test_static_output_closing_tx() {
5701         let chanmon_cfgs = create_chanmon_cfgs(2);
5702         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5703         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5704         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5705
5706         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5707
5708         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5709         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5710
5711         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5712         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5713         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5714
5715         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5716         assert_eq!(spend_txn.len(), 1);
5717         check_spends!(spend_txn[0], closing_tx);
5718
5719         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5720         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5721
5722         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5723         assert_eq!(spend_txn.len(), 1);
5724         check_spends!(spend_txn[0], closing_tx);
5725 }
5726
5727 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5728         let chanmon_cfgs = create_chanmon_cfgs(2);
5729         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5730         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5731         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5732         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5733
5734         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5735
5736         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5737         // present in B's local commitment transaction, but none of A's commitment transactions.
5738         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5739         check_added_monitors!(nodes[1], 1);
5740
5741         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5742         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5743         let events = nodes[0].node.get_and_clear_pending_events();
5744         assert_eq!(events.len(), 1);
5745         match events[0] {
5746                 Event::PaymentSent { payment_preimage } => {
5747                         assert_eq!(payment_preimage, our_payment_preimage);
5748                 },
5749                 _ => panic!("Unexpected event"),
5750         }
5751
5752         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5753         check_added_monitors!(nodes[0], 1);
5754         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5755         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5756         check_added_monitors!(nodes[1], 1);
5757
5758         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5759         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5760                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5761                 header.prev_blockhash = header.bitcoin_hash();
5762         }
5763         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5764         check_closed_broadcast!(nodes[1], false);
5765         check_added_monitors!(nodes[1], 1);
5766 }
5767
5768 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5769         let chanmon_cfgs = create_chanmon_cfgs(2);
5770         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5771         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5772         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5773         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5774         let logger = test_utils::TestLogger::new();
5775
5776         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5777         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5778         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();
5779         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5780         check_added_monitors!(nodes[0], 1);
5781
5782         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5783
5784         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5785         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5786         // to "time out" the HTLC.
5787
5788         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5789
5790         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5791                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5792                 header.prev_blockhash = header.bitcoin_hash();
5793         }
5794         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5795         check_closed_broadcast!(nodes[0], false);
5796         check_added_monitors!(nodes[0], 1);
5797 }
5798
5799 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5800         let chanmon_cfgs = create_chanmon_cfgs(3);
5801         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5802         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5803         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5804         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5805
5806         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5807         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5808         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5809         // actually revoked.
5810         let htlc_value = if use_dust { 50000 } else { 3000000 };
5811         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5812         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5813         expect_pending_htlcs_forwardable!(nodes[1]);
5814         check_added_monitors!(nodes[1], 1);
5815
5816         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5817         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5818         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5819         check_added_monitors!(nodes[0], 1);
5820         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5821         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5822         check_added_monitors!(nodes[1], 1);
5823         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5824         check_added_monitors!(nodes[1], 1);
5825         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5826
5827         if check_revoke_no_close {
5828                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5829                 check_added_monitors!(nodes[0], 1);
5830         }
5831
5832         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5833         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5834                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5835                 header.prev_blockhash = header.bitcoin_hash();
5836         }
5837         if !check_revoke_no_close {
5838                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5839                 check_closed_broadcast!(nodes[0], false);
5840                 check_added_monitors!(nodes[0], 1);
5841         } else {
5842                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5843         }
5844 }
5845
5846 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5847 // There are only a few cases to test here:
5848 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5849 //    broadcastable commitment transactions result in channel closure,
5850 //  * its included in an unrevoked-but-previous remote commitment transaction,
5851 //  * its included in the latest remote or local commitment transactions.
5852 // We test each of the three possible commitment transactions individually and use both dust and
5853 // non-dust HTLCs.
5854 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5855 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5856 // tested for at least one of the cases in other tests.
5857 #[test]
5858 fn htlc_claim_single_commitment_only_a() {
5859         do_htlc_claim_local_commitment_only(true);
5860         do_htlc_claim_local_commitment_only(false);
5861
5862         do_htlc_claim_current_remote_commitment_only(true);
5863         do_htlc_claim_current_remote_commitment_only(false);
5864 }
5865
5866 #[test]
5867 fn htlc_claim_single_commitment_only_b() {
5868         do_htlc_claim_previous_remote_commitment_only(true, false);
5869         do_htlc_claim_previous_remote_commitment_only(false, false);
5870         do_htlc_claim_previous_remote_commitment_only(true, true);
5871         do_htlc_claim_previous_remote_commitment_only(false, true);
5872 }
5873
5874 fn run_onion_failure_test<F1,F2>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, callback_msg: F1, callback_node: F2, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
5875         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5876                                 F2: FnMut(),
5877 {
5878         run_onion_failure_test_with_fail_intercept(_name, test_case, nodes, route, payment_hash, callback_msg, |_|{}, callback_node, expected_retryable, expected_error_code, expected_channel_update);
5879 }
5880
5881 // test_case
5882 // 0: node1 fails backward
5883 // 1: final node fails backward
5884 // 2: payment completed but the user rejects the payment
5885 // 3: final node fails backward (but tamper onion payloads from node0)
5886 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5887 // 200: trigger error in the final node and tamper returning fail_htlc
5888 fn run_onion_failure_test_with_fail_intercept<F1,F2,F3>(_name: &str, test_case: u8, nodes: &Vec<Node>, route: &Route, payment_hash: &PaymentHash, mut callback_msg: F1, mut callback_fail: F2, mut callback_node: F3, expected_retryable: bool, expected_error_code: Option<u16>, expected_channel_update: Option<HTLCFailChannelUpdate>)
5889         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5890                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5891                                 F3: FnMut(),
5892 {
5893
5894         // reset block height
5895         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5896         for ix in 0..nodes.len() {
5897                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5898         }
5899
5900         macro_rules! expect_event {
5901                 ($node: expr, $event_type: path) => {{
5902                         let events = $node.node.get_and_clear_pending_events();
5903                         assert_eq!(events.len(), 1);
5904                         match events[0] {
5905                                 $event_type { .. } => {},
5906                                 _ => panic!("Unexpected event"),
5907                         }
5908                 }}
5909         }
5910
5911         macro_rules! expect_htlc_forward {
5912                 ($node: expr) => {{
5913                         expect_event!($node, Event::PendingHTLCsForwardable);
5914                         $node.node.process_pending_htlc_forwards();
5915                 }}
5916         }
5917
5918         // 0 ~~> 2 send payment
5919         nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5920         check_added_monitors!(nodes[0], 1);
5921         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5922         // temper update_add (0 => 1)
5923         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5924         if test_case == 0 || test_case == 3 || test_case == 100 {
5925                 callback_msg(&mut update_add_0);
5926                 callback_node();
5927         }
5928         // 0 => 1 update_add & CS
5929         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5930         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5931
5932         let update_1_0 = match test_case {
5933                 0|100 => { // intermediate node failure; fail backward to 0
5934                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5935                         assert!(update_1_0.update_fail_htlcs.len()+update_1_0.update_fail_malformed_htlcs.len()==1 && (update_1_0.update_fail_htlcs.len()==1 || update_1_0.update_fail_malformed_htlcs.len()==1));
5936                         update_1_0
5937                 },
5938                 1|2|3|200 => { // final node failure; forwarding to 2
5939                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5940                         // forwarding on 1
5941                         if test_case != 200 {
5942                                 callback_node();
5943                         }
5944                         expect_htlc_forward!(&nodes[1]);
5945
5946                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5947                         check_added_monitors!(&nodes[1], 1);
5948                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5949                         // tamper update_add (1 => 2)
5950                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5951                         if test_case != 3 && test_case != 200 {
5952                                 callback_msg(&mut update_add_1);
5953                         }
5954
5955                         // 1 => 2
5956                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5957                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5958
5959                         if test_case == 2 || test_case == 200 {
5960                                 expect_htlc_forward!(&nodes[2]);
5961                                 expect_event!(&nodes[2], Event::PaymentReceived);
5962                                 callback_node();
5963                                 expect_pending_htlcs_forwardable!(nodes[2]);
5964                         }
5965
5966                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5967                         if test_case == 2 || test_case == 200 {
5968                                 check_added_monitors!(&nodes[2], 1);
5969                         }
5970                         assert!(update_2_1.update_fail_htlcs.len() == 1);
5971
5972                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5973                         if test_case == 200 {
5974                                 callback_fail(&mut fail_msg);
5975                         }
5976
5977                         // 2 => 1
5978                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5979                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5980
5981                         // backward fail on 1
5982                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5983                         assert!(update_1_0.update_fail_htlcs.len() == 1);
5984                         update_1_0
5985                 },
5986                 _ => unreachable!(),
5987         };
5988
5989         // 1 => 0 commitment_signed_dance
5990         if update_1_0.update_fail_htlcs.len() > 0 {
5991                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5992                 if test_case == 100 {
5993                         callback_fail(&mut fail_msg);
5994                 }
5995                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5996         } else {
5997                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5998         };
5999
6000         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
6001
6002         let events = nodes[0].node.get_and_clear_pending_events();
6003         assert_eq!(events.len(), 1);
6004         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
6005                 assert_eq!(*rejected_by_dest, !expected_retryable);
6006                 assert_eq!(*error_code, expected_error_code);
6007         } else {
6008                 panic!("Uexpected event");
6009         }
6010
6011         let events = nodes[0].node.get_and_clear_pending_msg_events();
6012         if expected_channel_update.is_some() {
6013                 assert_eq!(events.len(), 1);
6014                 match events[0] {
6015                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
6016                                 match update {
6017                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
6018                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
6019                                                         panic!("channel_update not found!");
6020                                                 }
6021                                         },
6022                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
6023                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6024                                                         assert!(*short_channel_id == *expected_short_channel_id);
6025                                                         assert!(*is_permanent == *expected_is_permanent);
6026                                                 } else {
6027                                                         panic!("Unexpected message event");
6028                                                 }
6029                                         },
6030                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
6031                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6032                                                         assert!(*node_id == *expected_node_id);
6033                                                         assert!(*is_permanent == *expected_is_permanent);
6034                                                 } else {
6035                                                         panic!("Unexpected message event");
6036                                                 }
6037                                         },
6038                                 }
6039                         },
6040                         _ => panic!("Unexpected message event"),
6041                 }
6042         } else {
6043                 assert_eq!(events.len(), 0);
6044         }
6045 }
6046
6047 impl msgs::ChannelUpdate {
6048         fn dummy() -> msgs::ChannelUpdate {
6049                 use bitcoin::secp256k1::ffi::Signature as FFISignature;
6050                 use bitcoin::secp256k1::Signature;
6051                 msgs::ChannelUpdate {
6052                         signature: Signature::from(FFISignature::new()),
6053                         contents: msgs::UnsignedChannelUpdate {
6054                                 chain_hash: BlockHash::hash(&vec![0u8][..]),
6055                                 short_channel_id: 0,
6056                                 timestamp: 0,
6057                                 flags: 0,
6058                                 cltv_expiry_delta: 0,
6059                                 htlc_minimum_msat: 0,
6060                                 htlc_maximum_msat: OptionalField::Absent,
6061                                 fee_base_msat: 0,
6062                                 fee_proportional_millionths: 0,
6063                                 excess_data: vec![],
6064                         }
6065                 }
6066         }
6067 }
6068
6069 struct BogusOnionHopData {
6070         data: Vec<u8>
6071 }
6072 impl BogusOnionHopData {
6073         fn new(orig: msgs::OnionHopData) -> Self {
6074                 Self { data: orig.encode() }
6075         }
6076 }
6077 impl Writeable for BogusOnionHopData {
6078         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6079                 writer.write_all(&self.data[..])
6080         }
6081 }
6082
6083 #[test]
6084 fn test_onion_failure() {
6085         use ln::msgs::ChannelUpdate;
6086         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
6087         use bitcoin::secp256k1;
6088
6089         const BADONION: u16 = 0x8000;
6090         const PERM: u16 = 0x4000;
6091         const NODE: u16 = 0x2000;
6092         const UPDATE: u16 = 0x1000;
6093
6094         let chanmon_cfgs = create_chanmon_cfgs(3);
6095         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6096         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6097         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6098         for node in nodes.iter() {
6099                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
6100         }
6101         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known())];
6102         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
6103         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6104         let logger = test_utils::TestLogger::new();
6105         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(), 40000, TEST_FINAL_CLTV, &logger).unwrap();
6106         // positve case
6107         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
6108
6109         // intermediate node failure
6110         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
6111                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6112                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6113                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6114                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6115                 let mut new_payloads = Vec::new();
6116                 for payload in onion_payloads.drain(..) {
6117                         new_payloads.push(BogusOnionHopData::new(payload));
6118                 }
6119                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
6120                 // describing a length-1 TLV payload, which is obviously bogus.
6121                 new_payloads[0].data[0] = 1;
6122                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6123         }, ||{}, true, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
6124
6125         // final node failure
6126         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
6127                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6128                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6129                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6130                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6131                 let mut new_payloads = Vec::new();
6132                 for payload in onion_payloads.drain(..) {
6133                         new_payloads.push(BogusOnionHopData::new(payload));
6134                 }
6135                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
6136                 // length-1 TLV payload, which is obviously bogus.
6137                 new_payloads[1].data[0] = 1;
6138                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6139         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6140
6141         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
6142         // receiving simulated fail messages
6143         // intermediate node failure
6144         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6145                 // trigger error
6146                 msg.amount_msat -= 1;
6147         }, |msg| {
6148                 // and tamper returning error message
6149                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6150                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6151                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
6152         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
6153
6154         // final node failure
6155         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6156                 // and tamper returning error message
6157                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6158                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6159                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
6160         }, ||{
6161                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6162         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
6163
6164         // intermediate node failure
6165         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6166                 msg.amount_msat -= 1;
6167         }, |msg| {
6168                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6169                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6170                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
6171         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6172
6173         // final node failure
6174         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6175                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6176                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6177                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
6178         }, ||{
6179                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6180         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6181
6182         // intermediate node failure
6183         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6184                 msg.amount_msat -= 1;
6185         }, |msg| {
6186                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6187                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6188                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
6189         }, ||{
6190                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6191         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6192
6193         // final node failure
6194         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6195                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6196                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6197                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
6198         }, ||{
6199                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6200         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6201
6202         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
6203                 Some(BADONION|PERM|4), None);
6204
6205         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
6206                 Some(BADONION|PERM|5), None);
6207
6208         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
6209                 Some(BADONION|PERM|6), None);
6210
6211         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6212                 msg.amount_msat -= 1;
6213         }, |msg| {
6214                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6215                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6216                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
6217         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6218
6219         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6220                 msg.amount_msat -= 1;
6221         }, |msg| {
6222                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6223                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6224                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
6225                 // short_channel_id from the processing node
6226         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6227
6228         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6229                 msg.amount_msat -= 1;
6230         }, |msg| {
6231                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6232                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6233                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
6234                 // short_channel_id from the processing node
6235         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6236
6237         let mut bogus_route = route.clone();
6238         bogus_route.paths[0][1].short_channel_id -= 1;
6239         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
6240           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
6241
6242         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
6243         let mut bogus_route = route.clone();
6244         let route_len = bogus_route.paths[0].len();
6245         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
6246         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6247
6248         //TODO: with new config API, we will be able to generate both valid and
6249         //invalid channel_update cases.
6250         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
6251                 msg.amount_msat -= 1;
6252         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6253
6254         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
6255                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
6256                 msg.cltv_expiry -= 1;
6257         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6258
6259         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
6260                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6261                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6262
6263                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
6264         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6265
6266         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
6267                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6268         }, false, Some(PERM|15), None);
6269
6270         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
6271                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6272                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6273
6274                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
6275         }, || {}, true, Some(17), None);
6276
6277         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
6278                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6279                         for f in pending_forwards.iter_mut() {
6280                                 match f {
6281                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6282                                                 forward_info.outgoing_cltv_value += 1,
6283                                         _ => {},
6284                                 }
6285                         }
6286                 }
6287         }, true, Some(18), None);
6288
6289         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
6290                 // violate amt_to_forward > msg.amount_msat
6291                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6292                         for f in pending_forwards.iter_mut() {
6293                                 match f {
6294                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6295                                                 forward_info.amt_to_forward -= 1,
6296                                         _ => {},
6297                                 }
6298                         }
6299                 }
6300         }, true, Some(19), None);
6301
6302         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
6303                 // disconnect event to the channel between nodes[1] ~ nodes[2]
6304                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
6305                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6306         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6307         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6308
6309         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
6310                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6311                 let mut route = route.clone();
6312                 let height = 1;
6313                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
6314                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6315                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
6316                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
6317                 msg.cltv_expiry = htlc_cltv;
6318                 msg.onion_routing_packet = onion_packet;
6319         }, ||{}, true, Some(21), None);
6320 }
6321
6322 #[test]
6323 #[should_panic]
6324 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6325         let chanmon_cfgs = create_chanmon_cfgs(2);
6326         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6327         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6328         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6329         //Force duplicate channel ids
6330         for node in nodes.iter() {
6331                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6332         }
6333
6334         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6335         let channel_value_satoshis=10000;
6336         let push_msat=10001;
6337         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6338         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6339         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6340
6341         //Create a second channel with a channel_id collision
6342         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6343 }
6344
6345 #[test]
6346 fn bolt2_open_channel_sending_node_checks_part2() {
6347         let chanmon_cfgs = create_chanmon_cfgs(2);
6348         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6349         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6350         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6351
6352         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6353         let channel_value_satoshis=2^24;
6354         let push_msat=10001;
6355         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6356
6357         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6358         let channel_value_satoshis=10000;
6359         // Test when push_msat is equal to 1000 * funding_satoshis.
6360         let push_msat=1000*channel_value_satoshis+1;
6361         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6362
6363         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6364         let channel_value_satoshis=10000;
6365         let push_msat=10001;
6366         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
6367         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6368         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6369
6370         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6371         // 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
6372         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6373
6374         // 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.
6375         assert!(BREAKDOWN_TIMEOUT>0);
6376         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6377
6378         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6379         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
6380         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6381
6382         // 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.
6383         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6384         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6385         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6386         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6387         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6388 }
6389
6390 // Test that if we fail to send an HTLC that is being freed from the holding cell, and the HTLC
6391 // originated from our node, its failure is surfaced to the user. We trigger this failure to
6392 // free the HTLC by increasing our fee while the HTLC is in the holding cell such that the HTLC
6393 // is no longer affordable once it's freed.
6394 #[test]
6395 fn test_fail_holding_cell_htlc_upon_free() {
6396         let chanmon_cfgs = create_chanmon_cfgs(2);
6397         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6398         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6399         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6400         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6401         let logger = test_utils::TestLogger::new();
6402
6403         // First nodes[0] generates an update_fee, setting the channel's
6404         // pending_update_fee.
6405         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 20).unwrap();
6406         check_added_monitors!(nodes[0], 1);
6407
6408         let events = nodes[0].node.get_and_clear_pending_msg_events();
6409         assert_eq!(events.len(), 1);
6410         let (update_msg, commitment_signed) = match events[0] {
6411                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6412                         (update_fee.as_ref(), commitment_signed)
6413                 },
6414                 _ => panic!("Unexpected event"),
6415         };
6416
6417         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6418
6419         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6420         let channel_reserve = chan_stat.channel_reserve_msat;
6421         let feerate = get_feerate!(nodes[0], chan.2);
6422
6423         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6424         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6425         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1);
6426         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6427         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();
6428
6429         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6430         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6431         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6432         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6433
6434         // Flush the pending fee update.
6435         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6436         let (as_revoke_and_ack, _) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6437         check_added_monitors!(nodes[1], 1);
6438         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
6439         check_added_monitors!(nodes[0], 1);
6440
6441         // Upon receipt of the RAA, there will be an attempt to resend the holding cell
6442         // HTLC, but now that the fee has been raised the payment will now fail, causing
6443         // us to surface its failure to the user.
6444         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6445         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6446         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 1 HTLC updates".to_string(), 1);
6447         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put us under local channel reserve value ({})", log_bytes!(our_payment_hash.0), chan_stat.channel_reserve_msat);
6448         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6449
6450         // Check that the payment failed to be sent out.
6451         let events = nodes[0].node.get_and_clear_pending_events();
6452         assert_eq!(events.len(), 1);
6453         match &events[0] {
6454                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6455                         assert_eq!(our_payment_hash.clone(), *payment_hash);
6456                         assert_eq!(*rejected_by_dest, false);
6457                         assert_eq!(*error_code, None);
6458                         assert_eq!(*error_data, None);
6459                 },
6460                 _ => panic!("Unexpected event"),
6461         }
6462 }
6463
6464 // Test that if multiple HTLCs are released from the holding cell and one is
6465 // valid but the other is no longer valid upon release, the valid HTLC can be
6466 // successfully completed while the other one fails as expected.
6467 #[test]
6468 fn test_free_and_fail_holding_cell_htlcs() {
6469         let chanmon_cfgs = create_chanmon_cfgs(2);
6470         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6471         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6472         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6473         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6474         let logger = test_utils::TestLogger::new();
6475
6476         // First nodes[0] generates an update_fee, setting the channel's
6477         // pending_update_fee.
6478         nodes[0].node.update_fee(chan.2, get_feerate!(nodes[0], chan.2) + 200).unwrap();
6479         check_added_monitors!(nodes[0], 1);
6480
6481         let events = nodes[0].node.get_and_clear_pending_msg_events();
6482         assert_eq!(events.len(), 1);
6483         let (update_msg, commitment_signed) = match events[0] {
6484                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6485                         (update_fee.as_ref(), commitment_signed)
6486                 },
6487                 _ => panic!("Unexpected event"),
6488         };
6489
6490         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
6491
6492         let mut chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6493         let channel_reserve = chan_stat.channel_reserve_msat;
6494         let feerate = get_feerate!(nodes[0], chan.2);
6495
6496         // 2* and +1 HTLCs on the commit tx fee calculation for the fee spike reserve.
6497         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6498         let amt_1 = 20000;
6499         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6500         let amt_2 = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 2 + 1) - amt_1;
6501         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6502         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();
6503         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();
6504
6505         // Send 2 payments which pass reserve checks but get stuck in the holding cell.
6506         nodes[0].node.send_payment(&route_1, payment_hash_1, &None).unwrap();
6507         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6508         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1);
6509         nodes[0].node.send_payment(&route_2, payment_hash_2, &None).unwrap();
6510         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6511         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, amt_1 + amt_2);
6512
6513         // Flush the pending fee update.
6514         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
6515         let (revoke_and_ack, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6516         check_added_monitors!(nodes[1], 1);
6517         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_and_ack);
6518         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6519         check_added_monitors!(nodes[0], 2);
6520
6521         // Upon receipt of the RAA, there will be an attempt to resend the holding cell HTLCs,
6522         // but now that the fee has been raised the second payment will now fail, causing us
6523         // to surface its failure to the user. The first payment should succeed.
6524         chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6525         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, 0);
6526         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), "Freeing holding cell with 2 HTLC updates".to_string(), 1);
6527         let failure_log = format!("Failed to send HTLC with payment_hash {} due to Cannot send value that would put us under local channel reserve value ({})", log_bytes!(payment_hash_2.0), chan_stat.channel_reserve_msat);
6528         nodes[0].logger.assert_log("lightning::ln::channel".to_string(), failure_log.to_string(), 1);
6529
6530         // Check that the second payment failed to be sent out.
6531         let events = nodes[0].node.get_and_clear_pending_events();
6532         assert_eq!(events.len(), 1);
6533         match &events[0] {
6534                 &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, ref error_code, ref error_data } => {
6535                         assert_eq!(payment_hash_2.clone(), *payment_hash);
6536                         assert_eq!(*rejected_by_dest, false);
6537                         assert_eq!(*error_code, None);
6538                         assert_eq!(*error_data, None);
6539                 },
6540                 _ => panic!("Unexpected event"),
6541         }
6542
6543         // Complete the first payment and the RAA from the fee update.
6544         let (payment_event, send_raa_event) = {
6545                 let mut msgs = nodes[0].node.get_and_clear_pending_msg_events();
6546                 assert_eq!(msgs.len(), 2);
6547                 (SendEvent::from_event(msgs.remove(0)), msgs.remove(0))
6548         };
6549         let raa = match send_raa_event {
6550                 MessageSendEvent::SendRevokeAndACK { msg, .. } => msg,
6551                 _ => panic!("Unexpected event"),
6552         };
6553         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6554         check_added_monitors!(nodes[1], 1);
6555         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6556         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6557         let events = nodes[1].node.get_and_clear_pending_events();
6558         assert_eq!(events.len(), 1);
6559         match events[0] {
6560                 Event::PendingHTLCsForwardable { .. } => {},
6561                 _ => panic!("Unexpected event"),
6562         }
6563         nodes[1].node.process_pending_htlc_forwards();
6564         let events = nodes[1].node.get_and_clear_pending_events();
6565         assert_eq!(events.len(), 1);
6566         match events[0] {
6567                 Event::PaymentReceived { .. } => {},
6568                 _ => panic!("Unexpected event"),
6569         }
6570         nodes[1].node.claim_funds(payment_preimage_1, &None, amt_1);
6571         check_added_monitors!(nodes[1], 1);
6572         let update_msgs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6573         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msgs.update_fulfill_htlcs[0]);
6574         commitment_signed_dance!(nodes[0], nodes[1], update_msgs.commitment_signed, false, true);
6575         let events = nodes[0].node.get_and_clear_pending_events();
6576         assert_eq!(events.len(), 1);
6577         match events[0] {
6578                 Event::PaymentSent { ref payment_preimage } => {
6579                         assert_eq!(*payment_preimage, payment_preimage_1);
6580                 }
6581                 _ => panic!("Unexpected event"),
6582         }
6583 }
6584
6585 // Test that if we fail to forward an HTLC that is being freed from the holding cell that the
6586 // HTLC is failed backwards. We trigger this failure to forward the freed HTLC by increasing
6587 // our fee while the HTLC is in the holding cell such that the HTLC is no longer affordable
6588 // once it's freed.
6589 #[test]
6590 fn test_fail_holding_cell_htlc_upon_free_multihop() {
6591         let chanmon_cfgs = create_chanmon_cfgs(3);
6592         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6593         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6594         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6595         let chan_0_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6596         let chan_1_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6597         let logger = test_utils::TestLogger::new();
6598
6599         // First nodes[1] generates an update_fee, setting the channel's
6600         // pending_update_fee.
6601         nodes[1].node.update_fee(chan_1_2.2, get_feerate!(nodes[1], chan_1_2.2) + 20).unwrap();
6602         check_added_monitors!(nodes[1], 1);
6603
6604         let events = nodes[1].node.get_and_clear_pending_msg_events();
6605         assert_eq!(events.len(), 1);
6606         let (update_msg, commitment_signed) = match events[0] {
6607                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
6608                         (update_fee.as_ref(), commitment_signed)
6609                 },
6610                 _ => panic!("Unexpected event"),
6611         };
6612
6613         nodes[2].node.handle_update_fee(&nodes[1].node.get_our_node_id(), update_msg.unwrap());
6614
6615         let mut chan_stat = get_channel_value_stat!(nodes[0], chan_0_1.2);
6616         let channel_reserve = chan_stat.channel_reserve_msat;
6617         let feerate = get_feerate!(nodes[0], chan_0_1.2);
6618
6619         // Send a payment which passes reserve checks but gets stuck in the holding cell.
6620         let feemsat = 239;
6621         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
6622         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6623         let max_can_send = 5000000 - channel_reserve - 2*commit_tx_fee_msat(feerate, 1 + 1) - total_routing_fee_msat;
6624         let payment_event = {
6625                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6626                 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();
6627                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6628                 check_added_monitors!(nodes[0], 1);
6629
6630                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6631                 assert_eq!(events.len(), 1);
6632
6633                 SendEvent::from_event(events.remove(0))
6634         };
6635         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6636         check_added_monitors!(nodes[1], 0);
6637         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6638         expect_pending_htlcs_forwardable!(nodes[1]);
6639
6640         chan_stat = get_channel_value_stat!(nodes[1], chan_1_2.2);
6641         assert_eq!(chan_stat.holding_cell_outbound_amount_msat, max_can_send);
6642
6643         // Flush the pending fee update.
6644         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
6645         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6646         check_added_monitors!(nodes[2], 1);
6647         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &raa);
6648         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &commitment_signed);
6649         check_added_monitors!(nodes[1], 2);
6650
6651         // A final RAA message is generated to finalize the fee update.
6652         let events = nodes[1].node.get_and_clear_pending_msg_events();
6653         assert_eq!(events.len(), 1);
6654
6655         let raa_msg = match &events[0] {
6656                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => {
6657                         msg.clone()
6658                 },
6659                 _ => panic!("Unexpected event"),
6660         };
6661
6662         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa_msg);
6663         check_added_monitors!(nodes[2], 1);
6664         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
6665
6666         // nodes[1]'s ChannelManager will now signal that we have HTLC forwards to process.
6667         let process_htlc_forwards_event = nodes[1].node.get_and_clear_pending_events();
6668         assert_eq!(process_htlc_forwards_event.len(), 1);
6669         match &process_htlc_forwards_event[0] {
6670                 &Event::PendingHTLCsForwardable { .. } => {},
6671                 _ => panic!("Unexpected event"),
6672         }
6673
6674         // In response, we call ChannelManager's process_pending_htlc_forwards
6675         nodes[1].node.process_pending_htlc_forwards();
6676         check_added_monitors!(nodes[1], 1);
6677
6678         // This causes the HTLC to be failed backwards.
6679         let fail_event = nodes[1].node.get_and_clear_pending_msg_events();
6680         assert_eq!(fail_event.len(), 1);
6681         let (fail_msg, commitment_signed) = match &fail_event[0] {
6682                 &MessageSendEvent::UpdateHTLCs { ref updates, .. } => {
6683                         assert_eq!(updates.update_add_htlcs.len(), 0);
6684                         assert_eq!(updates.update_fulfill_htlcs.len(), 0);
6685                         assert_eq!(updates.update_fail_malformed_htlcs.len(), 0);
6686                         assert_eq!(updates.update_fail_htlcs.len(), 1);
6687                         (updates.update_fail_htlcs[0].clone(), updates.commitment_signed.clone())
6688                 },
6689                 _ => panic!("Unexpected event"),
6690         };
6691
6692         // Pass the failure messages back to nodes[0].
6693         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6694         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
6695
6696         // Complete the HTLC failure+removal process.
6697         let (raa, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6698         check_added_monitors!(nodes[0], 1);
6699         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa);
6700         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
6701         check_added_monitors!(nodes[1], 2);
6702         let final_raa_event = nodes[1].node.get_and_clear_pending_msg_events();
6703         assert_eq!(final_raa_event.len(), 1);
6704         let raa = match &final_raa_event[0] {
6705                 &MessageSendEvent::SendRevokeAndACK { ref msg, .. } => msg.clone(),
6706                 _ => panic!("Unexpected event"),
6707         };
6708         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa);
6709         let fail_msg_event = nodes[0].node.get_and_clear_pending_msg_events();
6710         assert_eq!(fail_msg_event.len(), 1);
6711         match &fail_msg_event[0] {
6712                 &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
6713                 _ => panic!("Unexpected event"),
6714         }
6715         let failure_event = nodes[0].node.get_and_clear_pending_events();
6716         assert_eq!(failure_event.len(), 1);
6717         match &failure_event[0] {
6718                 &Event::PaymentFailed { rejected_by_dest, .. } => {
6719                         assert!(!rejected_by_dest);
6720                 },
6721                 _ => panic!("Unexpected event"),
6722         }
6723         check_added_monitors!(nodes[0], 1);
6724 }
6725
6726 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6727 // 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.
6728 //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.
6729
6730 #[test]
6731 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6732         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6733         let chanmon_cfgs = create_chanmon_cfgs(2);
6734         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6735         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6736         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6737         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6738
6739         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6740         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6741         let logger = test_utils::TestLogger::new();
6742         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();
6743         route.paths[0][0].fee_msat = 100;
6744
6745         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6746                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6747         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6748         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6749 }
6750
6751 #[test]
6752 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6753         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6754         let chanmon_cfgs = create_chanmon_cfgs(2);
6755         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6756         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6757         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6758         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6759         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6760
6761         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6762         let logger = test_utils::TestLogger::new();
6763         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();
6764         route.paths[0][0].fee_msat = 0;
6765         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6766                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6767
6768         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6769         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6770 }
6771
6772 #[test]
6773 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6774         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6775         let chanmon_cfgs = create_chanmon_cfgs(2);
6776         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6777         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6778         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6779         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6780
6781         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6782         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6783         let logger = test_utils::TestLogger::new();
6784         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();
6785         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6786         check_added_monitors!(nodes[0], 1);
6787         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6788         updates.update_add_htlcs[0].amount_msat = 0;
6789
6790         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6791         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6792         check_closed_broadcast!(nodes[1], true).unwrap();
6793         check_added_monitors!(nodes[1], 1);
6794 }
6795
6796 #[test]
6797 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6798         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6799         //It is enforced when constructing a route.
6800         let chanmon_cfgs = create_chanmon_cfgs(2);
6801         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6802         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6803         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6804         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6805         let logger = test_utils::TestLogger::new();
6806
6807         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6808
6809         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6810         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();
6811         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6812                 assert_eq!(err, &"Channel CLTV overflowed?"));
6813 }
6814
6815 #[test]
6816 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6817         //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.
6818         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6819         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6820         let chanmon_cfgs = create_chanmon_cfgs(2);
6821         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6822         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6823         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6824         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6825         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
6826
6827         let logger = test_utils::TestLogger::new();
6828         for i in 0..max_accepted_htlcs {
6829                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6830                 let payment_event = {
6831                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6832                         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
6833                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6834                         check_added_monitors!(nodes[0], 1);
6835
6836                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6837                         assert_eq!(events.len(), 1);
6838                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6839                                 assert_eq!(htlcs[0].htlc_id, i);
6840                         } else {
6841                                 assert!(false);
6842                         }
6843                         SendEvent::from_event(events.remove(0))
6844                 };
6845                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6846                 check_added_monitors!(nodes[1], 0);
6847                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6848
6849                 expect_pending_htlcs_forwardable!(nodes[1]);
6850                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6851         }
6852         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6853         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6854         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();
6855         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6856                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6857
6858         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6859         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6860 }
6861
6862 #[test]
6863 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6864         //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.
6865         let chanmon_cfgs = create_chanmon_cfgs(2);
6866         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6867         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6868         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6869         let channel_value = 100000;
6870         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6871         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
6872
6873         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6874
6875         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6876         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6877         let logger = test_utils::TestLogger::new();
6878         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();
6879         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6880                 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)));
6881
6882         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6883         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);
6884
6885         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6886 }
6887
6888 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6889 #[test]
6890 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6891         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6892         let chanmon_cfgs = create_chanmon_cfgs(2);
6893         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6894         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6895         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6896         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6897         let htlc_minimum_msat: u64;
6898         {
6899                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6900                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6901                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
6902         }
6903
6904         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6905         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6906         let logger = test_utils::TestLogger::new();
6907         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();
6908         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6909         check_added_monitors!(nodes[0], 1);
6910         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6911         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6912         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6913         assert!(nodes[1].node.list_channels().is_empty());
6914         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6915         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()));
6916         check_added_monitors!(nodes[1], 1);
6917 }
6918
6919 #[test]
6920 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6921         //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
6922         let chanmon_cfgs = create_chanmon_cfgs(2);
6923         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6924         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6925         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6926         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6927         let logger = test_utils::TestLogger::new();
6928
6929         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6930         let channel_reserve = chan_stat.channel_reserve_msat;
6931         let feerate = get_feerate!(nodes[0], chan.2);
6932         // The 2* and +1 are for the fee spike reserve.
6933         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6934
6935         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6936         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6937         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6938         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();
6939         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6940         check_added_monitors!(nodes[0], 1);
6941         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6942
6943         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6944         // at this time channel-initiatee receivers are not required to enforce that senders
6945         // respect the fee_spike_reserve.
6946         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6947         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6948
6949         assert!(nodes[1].node.list_channels().is_empty());
6950         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6951         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6952         check_added_monitors!(nodes[1], 1);
6953 }
6954
6955 #[test]
6956 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6957         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6958         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6959         let chanmon_cfgs = create_chanmon_cfgs(2);
6960         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6961         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6962         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6963         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6964         let logger = test_utils::TestLogger::new();
6965
6966         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6967         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6968
6969         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6970         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();
6971
6972         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6973         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6974         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6975         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6976
6977         let mut msg = msgs::UpdateAddHTLC {
6978                 channel_id: chan.2,
6979                 htlc_id: 0,
6980                 amount_msat: 1000,
6981                 payment_hash: our_payment_hash,
6982                 cltv_expiry: htlc_cltv,
6983                 onion_routing_packet: onion_packet.clone(),
6984         };
6985
6986         for i in 0..super::channel::OUR_MAX_HTLCS {
6987                 msg.htlc_id = i as u64;
6988                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6989         }
6990         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6991         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6992
6993         assert!(nodes[1].node.list_channels().is_empty());
6994         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6995         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6996         check_added_monitors!(nodes[1], 1);
6997 }
6998
6999 #[test]
7000 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
7001         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
7002         let chanmon_cfgs = create_chanmon_cfgs(2);
7003         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7004         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7005         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7006         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7007         let logger = test_utils::TestLogger::new();
7008
7009         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7010         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7011         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();
7012         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7013         check_added_monitors!(nodes[0], 1);
7014         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7015         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
7016         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7017
7018         assert!(nodes[1].node.list_channels().is_empty());
7019         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7020         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
7021         check_added_monitors!(nodes[1], 1);
7022 }
7023
7024 #[test]
7025 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
7026         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
7027         let chanmon_cfgs = create_chanmon_cfgs(2);
7028         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7029         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7030         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7031         let logger = test_utils::TestLogger::new();
7032
7033         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
7034         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7035         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7036         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();
7037         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7038         check_added_monitors!(nodes[0], 1);
7039         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7040         updates.update_add_htlcs[0].cltv_expiry = 500000000;
7041         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7042
7043         assert!(nodes[1].node.list_channels().is_empty());
7044         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7045         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
7046         check_added_monitors!(nodes[1], 1);
7047 }
7048
7049 #[test]
7050 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
7051         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
7052         // We test this by first testing that that repeated HTLCs pass commitment signature checks
7053         // after disconnect and that non-sequential htlc_ids result in a channel failure.
7054         let chanmon_cfgs = create_chanmon_cfgs(2);
7055         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7056         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7057         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7058         let logger = test_utils::TestLogger::new();
7059
7060         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7061         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7062         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7063         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();
7064         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7065         check_added_monitors!(nodes[0], 1);
7066         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7067         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7068
7069         //Disconnect and Reconnect
7070         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7071         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7072         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7073         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7074         assert_eq!(reestablish_1.len(), 1);
7075         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7076         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7077         assert_eq!(reestablish_2.len(), 1);
7078         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7079         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7080         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7081         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7082
7083         //Resend HTLC
7084         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7085         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
7086         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
7087         check_added_monitors!(nodes[1], 1);
7088         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7089
7090         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7091
7092         assert!(nodes[1].node.list_channels().is_empty());
7093         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
7094         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
7095         check_added_monitors!(nodes[1], 1);
7096 }
7097
7098 #[test]
7099 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
7100         //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.
7101
7102         let chanmon_cfgs = create_chanmon_cfgs(2);
7103         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7104         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7105         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7106         let logger = test_utils::TestLogger::new();
7107         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7108         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7109         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7110         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();
7111         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7112
7113         check_added_monitors!(nodes[0], 1);
7114         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7115         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7116
7117         let update_msg = msgs::UpdateFulfillHTLC{
7118                 channel_id: chan.2,
7119                 htlc_id: 0,
7120                 payment_preimage: our_payment_preimage,
7121         };
7122
7123         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7124
7125         assert!(nodes[0].node.list_channels().is_empty());
7126         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7127         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()));
7128         check_added_monitors!(nodes[0], 1);
7129 }
7130
7131 #[test]
7132 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
7133         //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.
7134
7135         let chanmon_cfgs = create_chanmon_cfgs(2);
7136         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7137         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7138         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7139         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7140         let logger = test_utils::TestLogger::new();
7141
7142         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7143         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7144         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();
7145         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7146         check_added_monitors!(nodes[0], 1);
7147         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7148         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7149
7150         let update_msg = msgs::UpdateFailHTLC{
7151                 channel_id: chan.2,
7152                 htlc_id: 0,
7153                 reason: msgs::OnionErrorPacket { data: Vec::new()},
7154         };
7155
7156         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7157
7158         assert!(nodes[0].node.list_channels().is_empty());
7159         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7160         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()));
7161         check_added_monitors!(nodes[0], 1);
7162 }
7163
7164 #[test]
7165 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
7166         //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.
7167
7168         let chanmon_cfgs = create_chanmon_cfgs(2);
7169         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7170         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7171         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7172         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7173         let logger = test_utils::TestLogger::new();
7174
7175         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7176         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7177         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();
7178         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7179         check_added_monitors!(nodes[0], 1);
7180         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7181         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7182
7183         let update_msg = msgs::UpdateFailMalformedHTLC{
7184                 channel_id: chan.2,
7185                 htlc_id: 0,
7186                 sha256_of_onion: [1; 32],
7187                 failure_code: 0x8000,
7188         };
7189
7190         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7191
7192         assert!(nodes[0].node.list_channels().is_empty());
7193         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7194         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()));
7195         check_added_monitors!(nodes[0], 1);
7196 }
7197
7198 #[test]
7199 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
7200         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
7201
7202         let chanmon_cfgs = create_chanmon_cfgs(2);
7203         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7204         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7205         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7206         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7207
7208         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7209
7210         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
7211         check_added_monitors!(nodes[1], 1);
7212
7213         let events = nodes[1].node.get_and_clear_pending_msg_events();
7214         assert_eq!(events.len(), 1);
7215         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7216                 match events[0] {
7217                         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, .. } } => {
7218                                 assert!(update_add_htlcs.is_empty());
7219                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7220                                 assert!(update_fail_htlcs.is_empty());
7221                                 assert!(update_fail_malformed_htlcs.is_empty());
7222                                 assert!(update_fee.is_none());
7223                                 update_fulfill_htlcs[0].clone()
7224                         },
7225                         _ => panic!("Unexpected event"),
7226                 }
7227         };
7228
7229         update_fulfill_msg.htlc_id = 1;
7230
7231         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7232
7233         assert!(nodes[0].node.list_channels().is_empty());
7234         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7235         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
7236         check_added_monitors!(nodes[0], 1);
7237 }
7238
7239 #[test]
7240 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
7241         //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.
7242
7243         let chanmon_cfgs = create_chanmon_cfgs(2);
7244         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7245         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7246         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7247         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7248
7249         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
7250
7251         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
7252         check_added_monitors!(nodes[1], 1);
7253
7254         let events = nodes[1].node.get_and_clear_pending_msg_events();
7255         assert_eq!(events.len(), 1);
7256         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
7257                 match events[0] {
7258                         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, .. } } => {
7259                                 assert!(update_add_htlcs.is_empty());
7260                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7261                                 assert!(update_fail_htlcs.is_empty());
7262                                 assert!(update_fail_malformed_htlcs.is_empty());
7263                                 assert!(update_fee.is_none());
7264                                 update_fulfill_htlcs[0].clone()
7265                         },
7266                         _ => panic!("Unexpected event"),
7267                 }
7268         };
7269
7270         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
7271
7272         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
7273
7274         assert!(nodes[0].node.list_channels().is_empty());
7275         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7276         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
7277         check_added_monitors!(nodes[0], 1);
7278 }
7279
7280 #[test]
7281 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
7282         //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.
7283
7284         let chanmon_cfgs = create_chanmon_cfgs(2);
7285         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7286         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7287         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7288         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7289         let logger = test_utils::TestLogger::new();
7290
7291         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7292         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7293         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();
7294         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7295         check_added_monitors!(nodes[0], 1);
7296
7297         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7298         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7299
7300         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7301         check_added_monitors!(nodes[1], 0);
7302         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7303
7304         let events = nodes[1].node.get_and_clear_pending_msg_events();
7305
7306         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7307                 match events[0] {
7308                         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, .. } } => {
7309                                 assert!(update_add_htlcs.is_empty());
7310                                 assert!(update_fulfill_htlcs.is_empty());
7311                                 assert!(update_fail_htlcs.is_empty());
7312                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7313                                 assert!(update_fee.is_none());
7314                                 update_fail_malformed_htlcs[0].clone()
7315                         },
7316                         _ => panic!("Unexpected event"),
7317                 }
7318         };
7319         update_msg.failure_code &= !0x8000;
7320         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7321
7322         assert!(nodes[0].node.list_channels().is_empty());
7323         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7324         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7325         check_added_monitors!(nodes[0], 1);
7326 }
7327
7328 #[test]
7329 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7330         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7331         //    * 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.
7332
7333         let chanmon_cfgs = create_chanmon_cfgs(3);
7334         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7335         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7336         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7337         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7338         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7339         let logger = test_utils::TestLogger::new();
7340
7341         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7342
7343         //First hop
7344         let mut payment_event = {
7345                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7346                 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();
7347                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7348                 check_added_monitors!(nodes[0], 1);
7349                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7350                 assert_eq!(events.len(), 1);
7351                 SendEvent::from_event(events.remove(0))
7352         };
7353         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7354         check_added_monitors!(nodes[1], 0);
7355         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7356         expect_pending_htlcs_forwardable!(nodes[1]);
7357         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7358         assert_eq!(events_2.len(), 1);
7359         check_added_monitors!(nodes[1], 1);
7360         payment_event = SendEvent::from_event(events_2.remove(0));
7361         assert_eq!(payment_event.msgs.len(), 1);
7362
7363         //Second Hop
7364         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7365         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7366         check_added_monitors!(nodes[2], 0);
7367         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7368
7369         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7370         assert_eq!(events_3.len(), 1);
7371         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7372                 match events_3[0] {
7373                         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 } } => {
7374                                 assert!(update_add_htlcs.is_empty());
7375                                 assert!(update_fulfill_htlcs.is_empty());
7376                                 assert!(update_fail_htlcs.is_empty());
7377                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7378                                 assert!(update_fee.is_none());
7379                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7380                         },
7381                         _ => panic!("Unexpected event"),
7382                 }
7383         };
7384
7385         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7386
7387         check_added_monitors!(nodes[1], 0);
7388         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7389         expect_pending_htlcs_forwardable!(nodes[1]);
7390         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7391         assert_eq!(events_4.len(), 1);
7392
7393         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7394         match events_4[0] {
7395                 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, .. } } => {
7396                         assert!(update_add_htlcs.is_empty());
7397                         assert!(update_fulfill_htlcs.is_empty());
7398                         assert_eq!(update_fail_htlcs.len(), 1);
7399                         assert!(update_fail_malformed_htlcs.is_empty());
7400                         assert!(update_fee.is_none());
7401                 },
7402                 _ => panic!("Unexpected event"),
7403         };
7404
7405         check_added_monitors!(nodes[1], 1);
7406 }
7407
7408 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7409         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7410         // 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
7411         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7412
7413         let chanmon_cfgs = create_chanmon_cfgs(2);
7414         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7415         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7416         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7417         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7418
7419         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7420
7421         // We route 2 dust-HTLCs between A and B
7422         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7423         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7424         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7425
7426         // Cache one local commitment tx as previous
7427         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7428
7429         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7430         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
7431         check_added_monitors!(nodes[1], 0);
7432         expect_pending_htlcs_forwardable!(nodes[1]);
7433         check_added_monitors!(nodes[1], 1);
7434
7435         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7436         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7437         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7438         check_added_monitors!(nodes[0], 1);
7439
7440         // Cache one local commitment tx as lastest
7441         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7442
7443         let events = nodes[0].node.get_and_clear_pending_msg_events();
7444         match events[0] {
7445                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7446                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7447                 },
7448                 _ => panic!("Unexpected event"),
7449         }
7450         match events[1] {
7451                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7452                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7453                 },
7454                 _ => panic!("Unexpected event"),
7455         }
7456
7457         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7458         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7459         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7460
7461         if announce_latest {
7462                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
7463         } else {
7464                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
7465         }
7466
7467         check_closed_broadcast!(nodes[0], false);
7468         check_added_monitors!(nodes[0], 1);
7469
7470         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7471         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
7472         let events = nodes[0].node.get_and_clear_pending_events();
7473         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7474         assert_eq!(events.len(), 2);
7475         let mut first_failed = false;
7476         for event in events {
7477                 match event {
7478                         Event::PaymentFailed { payment_hash, .. } => {
7479                                 if payment_hash == payment_hash_1 {
7480                                         assert!(!first_failed);
7481                                         first_failed = true;
7482                                 } else {
7483                                         assert_eq!(payment_hash, payment_hash_2);
7484                                 }
7485                         }
7486                         _ => panic!("Unexpected event"),
7487                 }
7488         }
7489 }
7490
7491 #[test]
7492 fn test_failure_delay_dust_htlc_local_commitment() {
7493         do_test_failure_delay_dust_htlc_local_commitment(true);
7494         do_test_failure_delay_dust_htlc_local_commitment(false);
7495 }
7496
7497 #[test]
7498 fn test_no_failure_dust_htlc_local_commitment() {
7499         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
7500         // prone to error, we test here that a dummy transaction don't fail them.
7501
7502         let chanmon_cfgs = create_chanmon_cfgs(2);
7503         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7504         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7505         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7506         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7507
7508         // Rebalance a bit
7509         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7510
7511         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7512         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7513
7514         // We route 2 dust-HTLCs between A and B
7515         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7516         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
7517
7518         // Build a dummy invalid transaction trying to spend a commitment tx
7519         let input = TxIn {
7520                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
7521                 script_sig: Script::new(),
7522                 sequence: 0,
7523                 witness: Vec::new(),
7524         };
7525
7526         let outp = TxOut {
7527                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
7528                 value: 10000,
7529         };
7530
7531         let dummy_tx = Transaction {
7532                 version: 2,
7533                 lock_time: 0,
7534                 input: vec![input],
7535                 output: vec![outp]
7536         };
7537
7538         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7539         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
7540         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7541         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7542         // We broadcast a few more block to check everything is all right
7543         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
7544         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7545         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7546
7547         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
7548         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
7549 }
7550
7551 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7552         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7553         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7554         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7555         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7556         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7557         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7558
7559         let chanmon_cfgs = create_chanmon_cfgs(3);
7560         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7561         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7562         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7563         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7564
7565         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7566
7567         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7568         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7569
7570         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7571         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7572
7573         // We revoked bs_commitment_tx
7574         if revoked {
7575                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7576                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7577         }
7578
7579         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7580         let mut timeout_tx = Vec::new();
7581         if local {
7582                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7583                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7584                 check_closed_broadcast!(nodes[0], false);
7585                 check_added_monitors!(nodes[0], 1);
7586                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7587                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7588                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7589                 expect_payment_failed!(nodes[0], dust_hash, true);
7590                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7591                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7592                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7593                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7594                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7595                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7596                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7597                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7598         } else {
7599                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7600                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7601                 check_closed_broadcast!(nodes[0], false);
7602                 check_added_monitors!(nodes[0], 1);
7603                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7604                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7605                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7606                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7607                 if !revoked {
7608                         expect_payment_failed!(nodes[0], dust_hash, true);
7609                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7610                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7611                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7612                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7613                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7614                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7615                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7616                 } else {
7617                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7618                         // commitment tx
7619                         let events = nodes[0].node.get_and_clear_pending_events();
7620                         assert_eq!(events.len(), 2);
7621                         let first;
7622                         match events[0] {
7623                                 Event::PaymentFailed { payment_hash, .. } => {
7624                                         if payment_hash == dust_hash { first = true; }
7625                                         else { first = false; }
7626                                 },
7627                                 _ => panic!("Unexpected event"),
7628                         }
7629                         match events[1] {
7630                                 Event::PaymentFailed { payment_hash, .. } => {
7631                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7632                                         else { assert_eq!(payment_hash, dust_hash); }
7633                                 },
7634                                 _ => panic!("Unexpected event"),
7635                         }
7636                 }
7637         }
7638 }
7639
7640 #[test]
7641 fn test_sweep_outbound_htlc_failure_update() {
7642         do_test_sweep_outbound_htlc_failure_update(false, true);
7643         do_test_sweep_outbound_htlc_failure_update(false, false);
7644         do_test_sweep_outbound_htlc_failure_update(true, false);
7645 }
7646
7647 #[test]
7648 fn test_upfront_shutdown_script() {
7649         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7650         // enforce it at shutdown message
7651
7652         let mut config = UserConfig::default();
7653         config.channel_options.announced_channel = true;
7654         config.peer_channel_config_limits.force_announced_channel_preference = false;
7655         config.channel_options.commit_upfront_shutdown_pubkey = false;
7656         let user_cfgs = [None, Some(config), None];
7657         let chanmon_cfgs = create_chanmon_cfgs(3);
7658         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7659         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7660         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7661
7662         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7663         let flags = InitFeatures::known();
7664         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7665         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7666         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7667         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7668         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7669         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7670     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()));
7671         check_added_monitors!(nodes[2], 1);
7672
7673         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7674         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7675         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7676         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7677         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7678         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7679         let events = nodes[2].node.get_and_clear_pending_msg_events();
7680         assert_eq!(events.len(), 1);
7681         match events[0] {
7682                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7683                 _ => panic!("Unexpected event"),
7684         }
7685
7686         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7687         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7688         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7689         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7690         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7691         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7692         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7693         let events = nodes[1].node.get_and_clear_pending_msg_events();
7694         assert_eq!(events.len(), 1);
7695         match events[0] {
7696                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7697                 _ => panic!("Unexpected event"),
7698         }
7699
7700         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7701         // channel smoothly, opt-out is from channel initiator here
7702         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7703         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7704         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7705         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7706         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7707         let events = nodes[0].node.get_and_clear_pending_msg_events();
7708         assert_eq!(events.len(), 1);
7709         match events[0] {
7710                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7711                 _ => panic!("Unexpected event"),
7712         }
7713
7714         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7715         //// channel smoothly
7716         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7717         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7718         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7719         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7720         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7721         let events = nodes[0].node.get_and_clear_pending_msg_events();
7722         assert_eq!(events.len(), 2);
7723         match events[0] {
7724                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7725                 _ => panic!("Unexpected event"),
7726         }
7727         match events[1] {
7728                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7729                 _ => panic!("Unexpected event"),
7730         }
7731 }
7732
7733 #[test]
7734 fn test_user_configurable_csv_delay() {
7735         // We test our channel constructors yield errors when we pass them absurd csv delay
7736
7737         let mut low_our_to_self_config = UserConfig::default();
7738         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7739         let mut high_their_to_self_config = UserConfig::default();
7740         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7741         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7742         let chanmon_cfgs = create_chanmon_cfgs(2);
7743         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7744         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7745         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7746
7747         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7748         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet));
7749         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, &low_our_to_self_config) {
7750                 match error {
7751                         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())); },
7752                         _ => panic!("Unexpected event"),
7753                 }
7754         } else { assert!(false) }
7755
7756         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7757         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7758         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7759         open_channel.to_self_delay = 200;
7760         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &low_our_to_self_config) {
7761                 match error {
7762                         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()));  },
7763                         _ => panic!("Unexpected event"),
7764                 }
7765         } else { assert!(false); }
7766
7767         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7768         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7769         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()));
7770         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7771         accept_channel.to_self_delay = 200;
7772         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7773         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7774                 match action {
7775                         &ErrorAction::SendErrorMessage { ref msg } => {
7776                                 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()));
7777                         },
7778                         _ => { assert!(false); }
7779                 }
7780         } else { assert!(false); }
7781
7782         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7783         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7784         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7785         open_channel.to_self_delay = 200;
7786         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::known(), &open_channel, 0, &high_their_to_self_config) {
7787                 match error {
7788                         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())); },
7789                         _ => panic!("Unexpected event"),
7790                 }
7791         } else { assert!(false); }
7792 }
7793
7794 #[test]
7795 fn test_data_loss_protect() {
7796         // We want to be sure that :
7797         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7798         // * we close channel in case of detecting other being fallen behind
7799         // * we are able to claim our own outputs thanks to to_remote being static
7800         let keys_manager;
7801         let logger;
7802         let fee_estimator;
7803         let tx_broadcaster;
7804         let chain_monitor;
7805         let monitor;
7806         let node_state_0;
7807         let chanmon_cfgs = create_chanmon_cfgs(2);
7808         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7809         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7810         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7811
7812         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7813
7814         // Cache node A state before any channel update
7815         let previous_node_state = nodes[0].node.encode();
7816         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
7817         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
7818
7819         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7820         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7821
7822         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7823         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7824
7825         // Restore node A from previous state
7826         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7827         let mut chan_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0)).unwrap().1;
7828         chain_monitor = ChainWatchInterfaceUtil::new(Network::Testnet);
7829         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7830         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7831         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
7832         monitor = test_utils::TestChannelMonitor::new(&chain_monitor, &tx_broadcaster, &logger, &fee_estimator);
7833         node_state_0 = {
7834                 let mut channel_monitors = HashMap::new();
7835                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
7836                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
7837                         keys_manager: &keys_manager,
7838                         fee_estimator: &fee_estimator,
7839                         monitor: &monitor,
7840                         logger: &logger,
7841                         tx_broadcaster: &tx_broadcaster,
7842                         default_config: UserConfig::default(),
7843                         channel_monitors: &mut channel_monitors,
7844                 }).unwrap().1
7845         };
7846         nodes[0].node = &node_state_0;
7847         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
7848         nodes[0].chan_monitor = &monitor;
7849         nodes[0].chain_monitor = &chain_monitor;
7850
7851         nodes[0].block_notifier = BlockNotifier::new(&nodes[0].chain_monitor);
7852         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
7853         nodes[0].block_notifier.register_listener(nodes[0].node);
7854
7855         check_added_monitors!(nodes[0], 1);
7856
7857         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7858         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7859
7860         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7861
7862         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7863         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7864         check_added_monitors!(nodes[0], 1);
7865
7866         {
7867                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7868                 assert_eq!(node_txn.len(), 0);
7869         }
7870
7871         let mut reestablish_1 = Vec::with_capacity(1);
7872         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7873                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7874                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7875                         reestablish_1.push(msg.clone());
7876                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7877                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7878                         match action {
7879                                 &ErrorAction::SendErrorMessage { ref msg } => {
7880                                         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");
7881                                 },
7882                                 _ => panic!("Unexpected event!"),
7883                         }
7884                 } else {
7885                         panic!("Unexpected event")
7886                 }
7887         }
7888
7889         // Check we close channel detecting A is fallen-behind
7890         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7891         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7892         check_added_monitors!(nodes[1], 1);
7893
7894
7895         // Check A is able to claim to_remote output
7896         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7897         assert_eq!(node_txn.len(), 1);
7898         check_spends!(node_txn[0], chan.3);
7899         assert_eq!(node_txn[0].output.len(), 2);
7900         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7901         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7902         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
7903         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
7904         assert_eq!(spend_txn.len(), 1);
7905         check_spends!(spend_txn[0], node_txn[0]);
7906 }
7907
7908 #[test]
7909 fn test_check_htlc_underpaying() {
7910         // Send payment through A -> B but A is maliciously
7911         // sending a probe payment (i.e less than expected value0
7912         // to B, B should refuse payment.
7913
7914         let chanmon_cfgs = create_chanmon_cfgs(2);
7915         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7916         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7917         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7918
7919         // Create some initial channels
7920         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7921
7922         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7923
7924         // Node 3 is expecting payment of 100_000 but receive 10_000,
7925         // fail htlc like we didn't know the preimage.
7926         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7927         nodes[1].node.process_pending_htlc_forwards();
7928
7929         let events = nodes[1].node.get_and_clear_pending_msg_events();
7930         assert_eq!(events.len(), 1);
7931         let (update_fail_htlc, commitment_signed) = match events[0] {
7932                 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 } } => {
7933                         assert!(update_add_htlcs.is_empty());
7934                         assert!(update_fulfill_htlcs.is_empty());
7935                         assert_eq!(update_fail_htlcs.len(), 1);
7936                         assert!(update_fail_malformed_htlcs.is_empty());
7937                         assert!(update_fee.is_none());
7938                         (update_fail_htlcs[0].clone(), commitment_signed)
7939                 },
7940                 _ => panic!("Unexpected event"),
7941         };
7942         check_added_monitors!(nodes[1], 1);
7943
7944         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7945         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7946
7947         // 10_000 msat as u64, followed by a height of 99 as u32
7948         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7949         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
7950         expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7951         nodes[1].node.get_and_clear_pending_events();
7952 }
7953
7954 #[test]
7955 fn test_announce_disable_channels() {
7956         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7957         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7958
7959         let chanmon_cfgs = create_chanmon_cfgs(2);
7960         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7961         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7962         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7963
7964         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7965         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7966         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7967
7968         // Disconnect peers
7969         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7970         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7971
7972         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7973         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7974         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7975         assert_eq!(msg_events.len(), 3);
7976         for e in msg_events {
7977                 match e {
7978                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7979                                 let short_id = msg.contents.short_channel_id;
7980                                 // Check generated channel_update match list in PendingChannelUpdate
7981                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7982                                         panic!("Generated ChannelUpdate for wrong chan!");
7983                                 }
7984                         },
7985                         _ => panic!("Unexpected event"),
7986                 }
7987         }
7988         // Reconnect peers
7989         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7990         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7991         assert_eq!(reestablish_1.len(), 3);
7992         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7993         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7994         assert_eq!(reestablish_2.len(), 3);
7995
7996         // Reestablish chan_1
7997         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7998         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7999         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
8000         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8001         // Reestablish chan_2
8002         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
8003         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8004         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
8005         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8006         // Reestablish chan_3
8007         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
8008         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
8009         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
8010         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
8011
8012         nodes[0].node.timer_chan_freshness_every_min();
8013         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
8014 }
8015
8016 #[test]
8017 fn test_bump_penalty_txn_on_revoked_commitment() {
8018         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
8019         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
8020
8021         let chanmon_cfgs = create_chanmon_cfgs(2);
8022         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8023         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8024         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8025
8026         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8027         let logger = test_utils::TestLogger::new();
8028
8029
8030         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8031         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
8032         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();
8033         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
8034
8035         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
8036         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8037         assert_eq!(revoked_txn[0].output.len(), 4);
8038         assert_eq!(revoked_txn[0].input.len(), 1);
8039         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
8040         let revoked_txid = revoked_txn[0].txid();
8041
8042         let mut penalty_sum = 0;
8043         for outp in revoked_txn[0].output.iter() {
8044                 if outp.script_pubkey.is_v0_p2wsh() {
8045                         penalty_sum += outp.value;
8046                 }
8047         }
8048
8049         // Connect blocks to change height_timer range to see if we use right soonest_timelock
8050         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
8051
8052         // Actually revoke tx by claiming a HTLC
8053         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
8054         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8055         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
8056         check_added_monitors!(nodes[1], 1);
8057
8058         // One or more justice tx should have been broadcast, check it
8059         let penalty_1;
8060         let feerate_1;
8061         {
8062                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8063                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
8064                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8065                 assert_eq!(node_txn[0].output.len(), 1);
8066                 check_spends!(node_txn[0], revoked_txn[0]);
8067                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
8068                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
8069                 penalty_1 = node_txn[0].txid();
8070                 node_txn.clear();
8071         };
8072
8073         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
8074         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
8075         let mut penalty_2 = penalty_1;
8076         let mut feerate_2 = 0;
8077         {
8078                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8079                 assert_eq!(node_txn.len(), 1);
8080                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8081                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8082                         assert_eq!(node_txn[0].output.len(), 1);
8083                         check_spends!(node_txn[0], revoked_txn[0]);
8084                         penalty_2 = node_txn[0].txid();
8085                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8086                         assert_ne!(penalty_2, penalty_1);
8087                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
8088                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8089                         // Verify 25% bump heuristic
8090                         assert!(feerate_2 * 100 >= feerate_1 * 125);
8091                         node_txn.clear();
8092                 }
8093         }
8094         assert_ne!(feerate_2, 0);
8095
8096         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
8097         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
8098         let penalty_3;
8099         let mut feerate_3 = 0;
8100         {
8101                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8102                 assert_eq!(node_txn.len(), 1);
8103                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
8104                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
8105                         assert_eq!(node_txn[0].output.len(), 1);
8106                         check_spends!(node_txn[0], revoked_txn[0]);
8107                         penalty_3 = node_txn[0].txid();
8108                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
8109                         assert_ne!(penalty_3, penalty_2);
8110                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
8111                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
8112                         // Verify 25% bump heuristic
8113                         assert!(feerate_3 * 100 >= feerate_2 * 125);
8114                         node_txn.clear();
8115                 }
8116         }
8117         assert_ne!(feerate_3, 0);
8118
8119         nodes[1].node.get_and_clear_pending_events();
8120         nodes[1].node.get_and_clear_pending_msg_events();
8121 }
8122
8123 #[test]
8124 fn test_bump_penalty_txn_on_revoked_htlcs() {
8125         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
8126         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
8127
8128         let chanmon_cfgs = create_chanmon_cfgs(2);
8129         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8130         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8131         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8132
8133         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8134         // Lock HTLC in both directions
8135         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
8136         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8137
8138         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8139         assert_eq!(revoked_local_txn[0].input.len(), 1);
8140         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8141
8142         // Revoke local commitment tx
8143         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
8144
8145         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8146         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
8147         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
8148         check_closed_broadcast!(nodes[1], false);
8149         check_added_monitors!(nodes[1], 1);
8150
8151         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8152         assert_eq!(revoked_htlc_txn.len(), 4);
8153         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8154                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8155                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8156                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
8157                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8158                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
8159         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8160                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
8161                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
8162                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8163                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
8164                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
8165         }
8166
8167         // Broadcast set of revoked txn on A
8168         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
8169         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8170
8171         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8172         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
8173         let first;
8174         let feerate_1;
8175         let penalty_txn;
8176         {
8177                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8178                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
8179                 // Verify claim tx are spending revoked HTLC txn
8180                 assert_eq!(node_txn[4].input.len(), 2);
8181                 assert_eq!(node_txn[4].output.len(), 1);
8182                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8183                 first = node_txn[4].txid();
8184                 // Store both feerates for later comparison
8185                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
8186                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
8187                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8188                 node_txn.clear();
8189         }
8190
8191         // Connect three more block to see if bumped penalty are issued for HTLC txn
8192         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8193         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
8194         {
8195                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8196                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
8197
8198                 check_spends!(node_txn[0], revoked_local_txn[0]);
8199                 check_spends!(node_txn[1], revoked_local_txn[0]);
8200
8201                 node_txn.clear();
8202         };
8203
8204         // Few more blocks to confirm penalty txn
8205         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
8206         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
8207         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
8208         let node_txn = {
8209                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8210                 assert_eq!(node_txn.len(), 1);
8211
8212                 assert_eq!(node_txn[0].input.len(), 2);
8213                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
8214                 // Verify bumped tx is different and 25% bump heuristic
8215                 assert_ne!(first, node_txn[0].txid());
8216                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
8217                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
8218                 assert!(feerate_2 * 100 > feerate_1 * 125);
8219                 let txn = vec![node_txn[0].clone()];
8220                 node_txn.clear();
8221                 txn
8222         };
8223         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
8224         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8225         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
8226         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
8227         {
8228                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8229                 // We verify than no new transaction has been broadcast because previously
8230                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
8231                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
8232                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
8233                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
8234                 // up bumped justice generation.
8235                 assert_eq!(node_txn.len(), 0);
8236                 node_txn.clear();
8237         }
8238         check_closed_broadcast!(nodes[0], false);
8239         check_added_monitors!(nodes[0], 1);
8240 }
8241
8242 #[test]
8243 fn test_bump_penalty_txn_on_remote_commitment() {
8244         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
8245         // we're able to claim outputs on remote commitment transaction before timelocks expiration
8246
8247         // Create 2 HTLCs
8248         // Provide preimage for one
8249         // Check aggregation
8250
8251         let chanmon_cfgs = create_chanmon_cfgs(2);
8252         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8253         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8254         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8255
8256         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8257         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8258         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
8259
8260         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
8261         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
8262         assert_eq!(remote_txn[0].output.len(), 4);
8263         assert_eq!(remote_txn[0].input.len(), 1);
8264         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8265
8266         // Claim a HTLC without revocation (provide B monitor with preimage)
8267         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
8268         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8269         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
8270         check_added_monitors!(nodes[1], 2);
8271
8272         // One or more claim tx should have been broadcast, check it
8273         let timeout;
8274         let preimage;
8275         let feerate_timeout;
8276         let feerate_preimage;
8277         {
8278                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8279                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
8280                 assert_eq!(node_txn[0].input.len(), 1);
8281                 assert_eq!(node_txn[1].input.len(), 1);
8282                 check_spends!(node_txn[0], remote_txn[0]);
8283                 check_spends!(node_txn[1], remote_txn[0]);
8284                 check_spends!(node_txn[2], chan.3);
8285                 check_spends!(node_txn[3], node_txn[2]);
8286                 check_spends!(node_txn[4], node_txn[2]);
8287                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8288                         timeout = node_txn[0].txid();
8289                         let index = node_txn[0].input[0].previous_output.vout;
8290                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8291                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
8292
8293                         preimage = node_txn[1].txid();
8294                         let index = node_txn[1].input[0].previous_output.vout;
8295                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8296                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
8297                 } else {
8298                         timeout = node_txn[1].txid();
8299                         let index = node_txn[1].input[0].previous_output.vout;
8300                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8301                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8302
8303                         preimage = node_txn[0].txid();
8304                         let index = node_txn[0].input[0].previous_output.vout;
8305                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8306                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8307                 }
8308                 node_txn.clear();
8309         };
8310         assert_ne!(feerate_timeout, 0);
8311         assert_ne!(feerate_preimage, 0);
8312
8313         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8314         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
8315         {
8316                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8317                 assert_eq!(node_txn.len(), 2);
8318                 assert_eq!(node_txn[0].input.len(), 1);
8319                 assert_eq!(node_txn[1].input.len(), 1);
8320                 check_spends!(node_txn[0], remote_txn[0]);
8321                 check_spends!(node_txn[1], remote_txn[0]);
8322                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8323                         let index = node_txn[0].input[0].previous_output.vout;
8324                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8325                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8326                         assert!(new_feerate * 100 > feerate_timeout * 125);
8327                         assert_ne!(timeout, node_txn[0].txid());
8328
8329                         let index = node_txn[1].input[0].previous_output.vout;
8330                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8331                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8332                         assert!(new_feerate * 100 > feerate_preimage * 125);
8333                         assert_ne!(preimage, node_txn[1].txid());
8334                 } else {
8335                         let index = node_txn[1].input[0].previous_output.vout;
8336                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8337                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8338                         assert!(new_feerate * 100 > feerate_timeout * 125);
8339                         assert_ne!(timeout, node_txn[1].txid());
8340
8341                         let index = node_txn[0].input[0].previous_output.vout;
8342                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8343                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8344                         assert!(new_feerate * 100 > feerate_preimage * 125);
8345                         assert_ne!(preimage, node_txn[0].txid());
8346                 }
8347                 node_txn.clear();
8348         }
8349
8350         nodes[1].node.get_and_clear_pending_events();
8351         nodes[1].node.get_and_clear_pending_msg_events();
8352 }
8353
8354 #[test]
8355 fn test_set_outpoints_partial_claiming() {
8356         // - remote party claim tx, new bump tx
8357         // - disconnect remote claiming tx, new bump
8358         // - disconnect tx, see no tx anymore
8359         let chanmon_cfgs = create_chanmon_cfgs(2);
8360         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8361         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8362         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8363
8364         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8365         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8366         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8367
8368         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
8369         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
8370         assert_eq!(remote_txn.len(), 3);
8371         assert_eq!(remote_txn[0].output.len(), 4);
8372         assert_eq!(remote_txn[0].input.len(), 1);
8373         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8374         check_spends!(remote_txn[1], remote_txn[0]);
8375         check_spends!(remote_txn[2], remote_txn[0]);
8376
8377         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
8378         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
8379         // Provide node A with both preimage
8380         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
8381         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
8382         check_added_monitors!(nodes[0], 2);
8383         nodes[0].node.get_and_clear_pending_events();
8384         nodes[0].node.get_and_clear_pending_msg_events();
8385
8386         // Connect blocks on node A commitment transaction
8387         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8388         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
8389         check_closed_broadcast!(nodes[0], false);
8390         check_added_monitors!(nodes[0], 1);
8391         // Verify node A broadcast tx claiming both HTLCs
8392         {
8393                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8394                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
8395                 assert_eq!(node_txn.len(), 4);
8396                 check_spends!(node_txn[0], remote_txn[0]);
8397                 check_spends!(node_txn[1], chan.3);
8398                 check_spends!(node_txn[2], node_txn[1]);
8399                 check_spends!(node_txn[3], node_txn[1]);
8400                 assert_eq!(node_txn[0].input.len(), 2);
8401                 node_txn.clear();
8402         }
8403
8404         // Connect blocks on node B
8405         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
8406         check_closed_broadcast!(nodes[1], false);
8407         check_added_monitors!(nodes[1], 1);
8408         // Verify node B broadcast 2 HTLC-timeout txn
8409         let partial_claim_tx = {
8410                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8411                 assert_eq!(node_txn.len(), 3);
8412                 check_spends!(node_txn[1], node_txn[0]);
8413                 check_spends!(node_txn[2], node_txn[0]);
8414                 assert_eq!(node_txn[1].input.len(), 1);
8415                 assert_eq!(node_txn[2].input.len(), 1);
8416                 node_txn[1].clone()
8417         };
8418
8419         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
8420         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8421         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
8422         {
8423                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8424                 assert_eq!(node_txn.len(), 1);
8425                 check_spends!(node_txn[0], remote_txn[0]);
8426                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
8427                 node_txn.clear();
8428         }
8429         nodes[0].node.get_and_clear_pending_msg_events();
8430
8431         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
8432         nodes[0].block_notifier.block_disconnected(&header, 102);
8433         {
8434                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8435                 assert_eq!(node_txn.len(), 1);
8436                 check_spends!(node_txn[0], remote_txn[0]);
8437                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
8438                 node_txn.clear();
8439         }
8440
8441         //// Disconnect one more block and then reconnect multiple no transaction should be generated
8442         nodes[0].block_notifier.block_disconnected(&header, 101);
8443         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
8444         {
8445                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8446                 assert_eq!(node_txn.len(), 0);
8447                 node_txn.clear();
8448         }
8449 }
8450
8451 #[test]
8452 fn test_counterparty_raa_skip_no_crash() {
8453         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8454         // commitment transaction, we would have happily carried on and provided them the next
8455         // commitment transaction based on one RAA forward. This would probably eventually have led to
8456         // channel closure, but it would not have resulted in funds loss. Still, our
8457         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
8458         // check simply that the channel is closed in response to such an RAA, but don't check whether
8459         // we decide to punish our counterparty for revoking their funds (as we don't currently
8460         // implement that).
8461         let chanmon_cfgs = create_chanmon_cfgs(2);
8462         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8463         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8464         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8465         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8466
8467         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8468         let local_keys = &guard.by_id.get_mut(&channel_id).unwrap().local_keys;
8469         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8470         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8471                 &SecretKey::from_slice(&local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8472         let per_commitment_secret = local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8473
8474         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8475                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8476         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8477         check_added_monitors!(nodes[1], 1);
8478 }
8479
8480 #[test]
8481 fn test_bump_txn_sanitize_tracking_maps() {
8482         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8483         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8484
8485         let chanmon_cfgs = create_chanmon_cfgs(2);
8486         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8487         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8488         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8489
8490         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8491         // Lock HTLC in both directions
8492         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8493         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8494
8495         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8496         assert_eq!(revoked_local_txn[0].input.len(), 1);
8497         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8498
8499         // Revoke local commitment tx
8500         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8501
8502         // Broadcast set of revoked txn on A
8503         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
8504         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8505
8506         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8507         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
8508         check_closed_broadcast!(nodes[0], false);
8509         check_added_monitors!(nodes[0], 1);
8510         let penalty_txn = {
8511                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8512                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8513                 check_spends!(node_txn[0], revoked_local_txn[0]);
8514                 check_spends!(node_txn[1], revoked_local_txn[0]);
8515                 check_spends!(node_txn[2], revoked_local_txn[0]);
8516                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8517                 node_txn.clear();
8518                 penalty_txn
8519         };
8520         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8521         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
8522         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
8523         {
8524                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8525                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8526                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8527                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8528                 }
8529         }
8530 }
8531
8532 #[test]
8533 fn test_override_channel_config() {
8534         let chanmon_cfgs = create_chanmon_cfgs(2);
8535         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8536         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8537         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8538
8539         // Node0 initiates a channel to node1 using the override config.
8540         let mut override_config = UserConfig::default();
8541         override_config.own_channel_config.our_to_self_delay = 200;
8542
8543         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8544
8545         // Assert the channel created by node0 is using the override config.
8546         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8547         assert_eq!(res.channel_flags, 0);
8548         assert_eq!(res.to_self_delay, 200);
8549 }
8550
8551 #[test]
8552 fn test_override_0msat_htlc_minimum() {
8553         let mut zero_config = UserConfig::default();
8554         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8555         let chanmon_cfgs = create_chanmon_cfgs(2);
8556         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8557         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8558         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8559
8560         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8561         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8562         assert_eq!(res.htlc_minimum_msat, 1);
8563
8564         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8565         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8566         assert_eq!(res.htlc_minimum_msat, 1);
8567 }
8568
8569 #[test]
8570 fn test_simple_payment_secret() {
8571         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8572         // features, however.
8573         let chanmon_cfgs = create_chanmon_cfgs(3);
8574         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8575         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8576         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8577
8578         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8579         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8580         let logger = test_utils::TestLogger::new();
8581
8582         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8583         let payment_secret = PaymentSecret([0xdb; 32]);
8584         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8585         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();
8586         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8587         // Claiming with all the correct values but the wrong secret should result in nothing...
8588         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8589         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8590         // ...but with the right secret we should be able to claim all the way back
8591         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8592 }
8593
8594 #[test]
8595 fn test_simple_mpp() {
8596         // Simple test of sending a multi-path payment.
8597         let chanmon_cfgs = create_chanmon_cfgs(4);
8598         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8599         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8600         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8601
8602         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8603         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8604         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8605         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8606         let logger = test_utils::TestLogger::new();
8607
8608         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8609         let payment_secret = PaymentSecret([0xdb; 32]);
8610         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8611         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();
8612         let path = route.paths[0].clone();
8613         route.paths.push(path);
8614         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8615         route.paths[0][0].short_channel_id = chan_1_id;
8616         route.paths[0][1].short_channel_id = chan_3_id;
8617         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8618         route.paths[1][0].short_channel_id = chan_2_id;
8619         route.paths[1][1].short_channel_id = chan_4_id;
8620         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8621         // Claiming with all the correct values but the wrong secret should result in nothing...
8622         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8623         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8624         // ...but with the right secret we should be able to claim all the way back
8625         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8626 }
8627
8628 #[test]
8629 fn test_update_err_monitor_lockdown() {
8630         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8631         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8632         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8633         //
8634         // This scenario may happen in a watchtower setup, where watchtower process a block height
8635         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8636         // commitment at same time.
8637
8638         let chanmon_cfgs = create_chanmon_cfgs(2);
8639         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8640         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8641         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8642
8643         // Create some initial channel
8644         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8645         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8646
8647         // Rebalance the network to generate htlc in the two directions
8648         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8649
8650         // Route a HTLC from node 0 to node 1 (but don't settle)
8651         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8652
8653         // Copy SimpleManyChannelMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8654         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8655         let chain_monitor = chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet);
8656         let watchtower = {
8657                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8658                 let monitor = monitors.get(&outpoint).unwrap();
8659                 let mut w = test_utils::TestVecWriter(Vec::new());
8660                 monitor.write_for_disk(&mut w).unwrap();
8661                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8662                                 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
8663                 assert!(new_monitor == *monitor);
8664                 let watchtower = test_utils::TestChannelMonitor::new(&chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator);
8665                 assert!(watchtower.add_monitor(outpoint, new_monitor).is_ok());
8666                 watchtower
8667         };
8668         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8669         watchtower.simple_monitor.block_connected(&header, 200, &vec![], &vec![]);
8670
8671         // Try to update ChannelMonitor
8672         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8673         check_added_monitors!(nodes[1], 1);
8674         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8675         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8676         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8677         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8678                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8679                         if let Err(_) =  watchtower.simple_monitor.update_monitor(outpoint, update.clone()) {} else { assert!(false); }
8680                         if let Ok(_) = nodes[0].chan_monitor.update_monitor(outpoint, update) {} else { assert!(false); }
8681                 } else { assert!(false); }
8682         } else { assert!(false); };
8683         // Our local monitor is in-sync and hasn't processed yet timeout
8684         check_added_monitors!(nodes[0], 1);
8685         let events = nodes[0].node.get_and_clear_pending_events();
8686         assert_eq!(events.len(), 1);
8687 }