_ 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 block = Block {
 415                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 416                 txdata: vec![tx],
 417         };
 418         nodes[1].block_notifier.block_connected(&block, 1);
 419         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &get_event_msg!(nodes[1], MessageSendEvent::SendFundingLocked, nodes[0].node.get_our_node_id()));
 420
 421         nodes[0].block_notifier.block_connected(&block, 1);
 422         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 423         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 424
 425         for node in nodes {
 426                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
 427                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
 428                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
 429         }
 430 }
 431
 432 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 433         // Previously, we had issues deserializing channels when we hadn't connected the first block
 434         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 435         // serialization round-trips and simply do steps towards opening a channel and then drop the
 436         // Node objects.
 437
 438         let chanmon_cfgs = create_chanmon_cfgs(2);
 439         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 440         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 441         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 442
 443         if steps & 0b1000_0000 != 0{
 444                 let block = Block {
 445                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
 446                         txdata: vec![],
 447                 };
 448                 nodes[0].block_notifier.block_connected(&block, 1);
 449                 nodes[1].block_notifier.block_connected(&block, 1);
 450         }
 451
 452         if steps & 0x0f == 0 { return; }
 453         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 454         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 455
 456         if steps & 0x0f == 1 { return; }
 457         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &open_channel);
 458         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 459
 460         if steps & 0x0f == 2 { return; }
 461         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
 462
 463         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 464
 465         if steps & 0x0f == 3 { return; }
 466         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 467         check_added_monitors!(nodes[0], 0);
 468         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 469
 470         if steps & 0x0f == 4 { return; }
 471         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 472         {
 473                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
 474                 assert_eq!(added_monitors.len(), 1);
 475                 assert_eq!(added_monitors[0].0, funding_output);
 476                 added_monitors.clear();
 477         }
 478         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 479
 480         if steps & 0x0f == 5 { return; }
 481         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 482         {
 483                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 484                 assert_eq!(added_monitors.len(), 1);
 485                 assert_eq!(added_monitors[0].0, funding_output);
 486                 added_monitors.clear();
 487         }
 488
 489         let events_4 = nodes[0].node.get_and_clear_pending_events();
 490         assert_eq!(events_4.len(), 1);
 491         match events_4[0] {
 492                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 493                         assert_eq!(user_channel_id, 42);
 494                         assert_eq!(*funding_txo, funding_output);
 495                 },
 496                 _ => panic!("Unexpected event"),
 497         };
 498
 499         if steps & 0x0f == 6 { return; }
 500         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 501
 502         if steps & 0x0f == 7 { return; }
 503         confirm_transaction(&nodes[0].block_notifier, &tx);
 504         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 505 }
 506
 507 #[test]
 508 fn test_sanity_on_in_flight_opens() {
 509         do_test_sanity_on_in_flight_opens(0);
 510         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 511         do_test_sanity_on_in_flight_opens(1);
 512         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 513         do_test_sanity_on_in_flight_opens(2);
 514         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 515         do_test_sanity_on_in_flight_opens(3);
 516         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 517         do_test_sanity_on_in_flight_opens(4);
 518         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 519         do_test_sanity_on_in_flight_opens(5);
 520         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 521         do_test_sanity_on_in_flight_opens(6);
 522         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 523         do_test_sanity_on_in_flight_opens(7);
 524         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 525         do_test_sanity_on_in_flight_opens(8);
 526         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 527 }
 528
 529 #[test]
 530 fn test_update_fee_vanilla() {
 531         let chanmon_cfgs = create_chanmon_cfgs(2);
 532         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 533         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 534         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 535         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 536         let channel_id = chan.2;
 537
 538         let feerate = get_feerate!(nodes[0], channel_id);
 539         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 540         check_added_monitors!(nodes[0], 1);
 541
 542         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 543         assert_eq!(events_0.len(), 1);
 544         let (update_msg, commitment_signed) = match events_0[0] {
 545                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 546                         (update_fee.as_ref(), commitment_signed)
 547                 },
 548                 _ => panic!("Unexpected event"),
 549         };
 550         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 551
 552         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 553         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 554         check_added_monitors!(nodes[1], 1);
 555
 556         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 557         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 558         check_added_monitors!(nodes[0], 1);
 559
 560         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 561         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 562         // No commitment_signed so get_event_msg's assert(len == 1) passes
 563         check_added_monitors!(nodes[0], 1);
 564
 565         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 566         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 567         check_added_monitors!(nodes[1], 1);
 568 }
 569
 570 #[test]
 571 fn test_update_fee_that_funder_cannot_afford() {
 572         let chanmon_cfgs = create_chanmon_cfgs(2);
 573         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 574         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 575         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 576         let channel_value = 1888;
 577         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::known(), InitFeatures::known());
 578         let channel_id = chan.2;
 579
 580         let feerate = 260;
 581         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 582         check_added_monitors!(nodes[0], 1);
 583         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 584
 585         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 586
 587         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 588
 589         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 590         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 591         {
 592                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 593
 594                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 595                 let num_htlcs = commitment_tx.output.len() - 2;
 596                 let total_fee: u64 = feerate as u64 * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 597                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 598                 actual_fee = channel_value - actual_fee;
 599                 assert_eq!(total_fee, actual_fee);
 600         }
 601
 602         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 603         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 604         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 605         check_added_monitors!(nodes[0], 1);
 606
 607         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 608
 609         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 610
 611         //While producing the commitment_signed response after handling a received update_fee request the
 612         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 613         //Should produce and error.
 614         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 615         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 616         check_added_monitors!(nodes[1], 1);
 617         check_closed_broadcast!(nodes[1], true);
 618 }
 619
 620 #[test]
 621 fn test_update_fee_with_fundee_update_add_htlc() {
 622         let chanmon_cfgs = create_chanmon_cfgs(2);
 623         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 624         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 625         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 626         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 627         let channel_id = chan.2;
 628         let logger = test_utils::TestLogger::new();
 629
 630         // balancing
 631         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 632
 633         let feerate = get_feerate!(nodes[0], channel_id);
 634         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 635         check_added_monitors!(nodes[0], 1);
 636
 637         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 638         assert_eq!(events_0.len(), 1);
 639         let (update_msg, commitment_signed) = match events_0[0] {
 640                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 641                         (update_fee.as_ref(), commitment_signed)
 642                 },
 643                 _ => panic!("Unexpected event"),
 644         };
 645         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 646         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 647         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 648         check_added_monitors!(nodes[1], 1);
 649
 650         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 651         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
 652         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV, &logger).unwrap();
 653
 654         // nothing happens since node[1] is in AwaitingRemoteRevoke
 655         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
 656         {
 657                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 658                 assert_eq!(added_monitors.len(), 0);
 659                 added_monitors.clear();
 660         }
 661         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 662         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 663         // node[1] has nothing to do
 664
 665         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 666         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 667         check_added_monitors!(nodes[0], 1);
 668
 669         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 670         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 671         // No commitment_signed so get_event_msg's assert(len == 1) passes
 672         check_added_monitors!(nodes[0], 1);
 673         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 674         check_added_monitors!(nodes[1], 1);
 675         // AwaitingRemoteRevoke ends here
 676
 677         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 678         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 679         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 680         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 681         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 682         assert_eq!(commitment_update.update_fee.is_none(), true);
 683
 684         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 685         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 686         check_added_monitors!(nodes[0], 1);
 687         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 688
 689         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 690         check_added_monitors!(nodes[1], 1);
 691         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 692
 693         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 694         check_added_monitors!(nodes[1], 1);
 695         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 696         // No commitment_signed so get_event_msg's assert(len == 1) passes
 697
 698         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 699         check_added_monitors!(nodes[0], 1);
 700         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 701
 702         expect_pending_htlcs_forwardable!(nodes[0]);
 703
 704         let events = nodes[0].node.get_and_clear_pending_events();
 705         assert_eq!(events.len(), 1);
 706         match events[0] {
 707                 Event::PaymentReceived { .. } => { },
 708                 _ => panic!("Unexpected event"),
 709         };
 710
 711         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 712
 713         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 714         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 715         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 716 }
 717
 718 #[test]
 719 fn test_update_fee() {
 720         let chanmon_cfgs = create_chanmon_cfgs(2);
 721         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 722         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 723         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 724         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 725         let channel_id = chan.2;
 726
 727         // A                                        B
 728         // (1) update_fee/commitment_signed      ->
 729         //                                       <- (2) revoke_and_ack
 730         //                                       .- send (3) commitment_signed
 731         // (4) update_fee/commitment_signed      ->
 732         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 733         //                                       <- (3) commitment_signed delivered
 734         // send (6) revoke_and_ack               -.
 735         //                                       <- (5) deliver revoke_and_ack
 736         // (6) deliver revoke_and_ack            ->
 737         //                                       .- send (7) commitment_signed in response to (4)
 738         //                                       <- (7) deliver commitment_signed
 739         // revoke_and_ack                        ->
 740
 741         // Create and deliver (1)...
 742         let feerate = get_feerate!(nodes[0], channel_id);
 743         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 744         check_added_monitors!(nodes[0], 1);
 745
 746         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 747         assert_eq!(events_0.len(), 1);
 748         let (update_msg, commitment_signed) = match events_0[0] {
 749                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 750                         (update_fee.as_ref(), commitment_signed)
 751                 },
 752                 _ => panic!("Unexpected event"),
 753         };
 754         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 755
 756         // Generate (2) and (3):
 757         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 758         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 759         check_added_monitors!(nodes[1], 1);
 760
 761         // Deliver (2):
 762         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 763         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 764         check_added_monitors!(nodes[0], 1);
 765
 766         // Create and deliver (4)...
 767         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 768         check_added_monitors!(nodes[0], 1);
 769         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 770         assert_eq!(events_0.len(), 1);
 771         let (update_msg, commitment_signed) = match events_0[0] {
 772                         MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
 773                         (update_fee.as_ref(), commitment_signed)
 774                 },
 775                 _ => panic!("Unexpected event"),
 776         };
 777
 778         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 779         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 780         check_added_monitors!(nodes[1], 1);
 781         // ... creating (5)
 782         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 783         // No commitment_signed so get_event_msg's assert(len == 1) passes
 784
 785         // Handle (3), creating (6):
 786         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 787         check_added_monitors!(nodes[0], 1);
 788         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 789         // No commitment_signed so get_event_msg's assert(len == 1) passes
 790
 791         // Deliver (5):
 792         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 793         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 794         check_added_monitors!(nodes[0], 1);
 795
 796         // Deliver (6), creating (7):
 797         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 798         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 799         assert!(commitment_update.update_add_htlcs.is_empty());
 800         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 801         assert!(commitment_update.update_fail_htlcs.is_empty());
 802         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 803         assert!(commitment_update.update_fee.is_none());
 804         check_added_monitors!(nodes[1], 1);
 805
 806         // Deliver (7)
 807         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 808         check_added_monitors!(nodes[0], 1);
 809         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 810         // No commitment_signed so get_event_msg's assert(len == 1) passes
 811
 812         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 813         check_added_monitors!(nodes[1], 1);
 814         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 815
 816         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 817         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 818         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 819 }
 820
 821 #[test]
 822 fn pre_funding_lock_shutdown_test() {
 823         // Test sending a shutdown prior to funding_locked after funding generation
 824         let chanmon_cfgs = create_chanmon_cfgs(2);
 825         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 826         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 827         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 828         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::known(), InitFeatures::known());
 829         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 830         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 831         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 832
 833         nodes[0].node.close_channel(&OutPoint { txid: tx.txid(), index: 0 }.to_channel_id()).unwrap();
 834         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 835         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 836         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 837         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 838
 839         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 840         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 841         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 842         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 843         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 844         assert!(node_0_none.is_none());
 845
 846         assert!(nodes[0].node.list_channels().is_empty());
 847         assert!(nodes[1].node.list_channels().is_empty());
 848 }
 849
 850 #[test]
 851 fn updates_shutdown_wait() {
 852         // Test sending a shutdown with outstanding updates pending
 853         let chanmon_cfgs = create_chanmon_cfgs(3);
 854         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 855         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 856         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 857         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 858         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 859         let logger = test_utils::TestLogger::new();
 860
 861         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 862
 863         nodes[0].node.close_channel(&chan_1.2).unwrap();
 864         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 865         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 866         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 867         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 868
 869         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 870         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 871
 872         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 873
 874         let net_graph_msg_handler0 = &nodes[0].net_graph_msg_handler;
 875         let net_graph_msg_handler1 = &nodes[1].net_graph_msg_handler;
 876         let route_1 = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler0.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 877         let route_2 = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler1.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 878         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 879         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 880
 881         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 882         check_added_monitors!(nodes[2], 1);
 883         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 884         assert!(updates.update_add_htlcs.is_empty());
 885         assert!(updates.update_fail_htlcs.is_empty());
 886         assert!(updates.update_fail_malformed_htlcs.is_empty());
 887         assert!(updates.update_fee.is_none());
 888         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 889         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 890         check_added_monitors!(nodes[1], 1);
 891         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 892         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 893
 894         assert!(updates_2.update_add_htlcs.is_empty());
 895         assert!(updates_2.update_fail_htlcs.is_empty());
 896         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 897         assert!(updates_2.update_fee.is_none());
 898         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 899         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 900         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 901
 902         let events = nodes[0].node.get_and_clear_pending_events();
 903         assert_eq!(events.len(), 1);
 904         match events[0] {
 905                 Event::PaymentSent { ref payment_preimage } => {
 906                         assert_eq!(our_payment_preimage, *payment_preimage);
 907                 },
 908                 _ => panic!("Unexpected event"),
 909         }
 910
 911         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 912         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 913         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 914         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 915         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 916         assert!(node_0_none.is_none());
 917
 918         assert!(nodes[0].node.list_channels().is_empty());
 919
 920         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 921         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 922         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 923         assert!(nodes[1].node.list_channels().is_empty());
 924         assert!(nodes[2].node.list_channels().is_empty());
 925 }
 926
 927 #[test]
 928 fn htlc_fail_async_shutdown() {
 929         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 930         let chanmon_cfgs = create_chanmon_cfgs(3);
 931         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 932         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 933         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 934         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
 935         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
 936         let logger = test_utils::TestLogger::new();
 937
 938         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 939         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
 940         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV, &logger).unwrap();
 941         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 942         check_added_monitors!(nodes[0], 1);
 943         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 944         assert_eq!(updates.update_add_htlcs.len(), 1);
 945         assert!(updates.update_fulfill_htlcs.is_empty());
 946         assert!(updates.update_fail_htlcs.is_empty());
 947         assert!(updates.update_fail_malformed_htlcs.is_empty());
 948         assert!(updates.update_fee.is_none());
 949
 950         nodes[1].node.close_channel(&chan_1.2).unwrap();
 951         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 952         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 953         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 954
 955         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 956         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 957         check_added_monitors!(nodes[1], 1);
 958         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 959         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 960
 961         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 962         assert!(updates_2.update_add_htlcs.is_empty());
 963         assert!(updates_2.update_fulfill_htlcs.is_empty());
 964         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 965         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 966         assert!(updates_2.update_fee.is_none());
 967
 968         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 969         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 970
 971         expect_payment_failed!(nodes[0], our_payment_hash, false);
 972
 973         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 974         assert_eq!(msg_events.len(), 2);
 975         let node_0_closing_signed = match msg_events[0] {
 976                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 977                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 978                         (*msg).clone()
 979                 },
 980                 _ => panic!("Unexpected event"),
 981         };
 982         match msg_events[1] {
 983                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 984                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 985                 },
 986                 _ => panic!("Unexpected event"),
 987         }
 988
 989         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 990         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 991         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 992         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 993         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 994         assert!(node_0_none.is_none());
 995
 996         assert!(nodes[0].node.list_channels().is_empty());
 997
 998         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 999         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1000         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1001         assert!(nodes[1].node.list_channels().is_empty());
1002         assert!(nodes[2].node.list_channels().is_empty());
1003 }
1004
1005 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1006         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1007         // messages delivered prior to disconnect
1008         let chanmon_cfgs = create_chanmon_cfgs(3);
1009         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1010         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1011         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1012         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1013         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1014
1015         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1016
1017         nodes[1].node.close_channel(&chan_1.2).unwrap();
1018         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1019         if recv_count > 0 {
1020                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1021                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1022                 if recv_count > 1 {
1023                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1024                 }
1025         }
1026
1027         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1028         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1029
1030         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1031         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1032         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1033         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1034
1035         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1036         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1037         assert!(node_1_shutdown == node_1_2nd_shutdown);
1038
1039         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1040         let node_0_2nd_shutdown = if recv_count > 0 {
1041                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1042                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1043                 node_0_2nd_shutdown
1044         } else {
1045                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1046                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1047                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1048         };
1049         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1050
1051         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1052         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1053
1054         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1055         check_added_monitors!(nodes[2], 1);
1056         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1057         assert!(updates.update_add_htlcs.is_empty());
1058         assert!(updates.update_fail_htlcs.is_empty());
1059         assert!(updates.update_fail_malformed_htlcs.is_empty());
1060         assert!(updates.update_fee.is_none());
1061         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1062         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1063         check_added_monitors!(nodes[1], 1);
1064         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1065         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1066
1067         assert!(updates_2.update_add_htlcs.is_empty());
1068         assert!(updates_2.update_fail_htlcs.is_empty());
1069         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1070         assert!(updates_2.update_fee.is_none());
1071         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1072         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1073         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1074
1075         let events = nodes[0].node.get_and_clear_pending_events();
1076         assert_eq!(events.len(), 1);
1077         match events[0] {
1078                 Event::PaymentSent { ref payment_preimage } => {
1079                         assert_eq!(our_payment_preimage, *payment_preimage);
1080                 },
1081                 _ => panic!("Unexpected event"),
1082         }
1083
1084         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1085         if recv_count > 0 {
1086                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1087                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1088                 assert!(node_1_closing_signed.is_some());
1089         }
1090
1091         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1092         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1093
1094         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1095         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1096         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1097         if recv_count == 0 {
1098                 // If all closing_signeds weren't delivered we can just resume where we left off...
1099                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1100
1101                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1102                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1103                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1104
1105                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1106                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1107                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1108
1109                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1110                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1111
1112                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1113                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1114                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1115
1116                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1117                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1118                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1119                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1120                 assert!(node_0_none.is_none());
1121         } else {
1122                 // If one node, however, received + responded with an identical closing_signed we end
1123                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1124                 // There isn't really anything better we can do simply, but in the future we might
1125                 // explore storing a set of recently-closed channels that got disconnected during
1126                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1127                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1128                 // transaction.
1129                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1130
1131                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1132                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1133                 assert_eq!(msg_events.len(), 1);
1134                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1135                         match action {
1136                                 &ErrorAction::SendErrorMessage { ref msg } => {
1137                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1138                                         assert_eq!(msg.channel_id, chan_1.2);
1139                                 },
1140                                 _ => panic!("Unexpected event!"),
1141                         }
1142                 } else { panic!("Needed SendErrorMessage close"); }
1143
1144                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1145                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1146                 // closing_signed so we do it ourselves
1147                 check_closed_broadcast!(nodes[0], false);
1148                 check_added_monitors!(nodes[0], 1);
1149         }
1150
1151         assert!(nodes[0].node.list_channels().is_empty());
1152
1153         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1154         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1155         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1156         assert!(nodes[1].node.list_channels().is_empty());
1157         assert!(nodes[2].node.list_channels().is_empty());
1158 }
1159
1160 #[test]
1161 fn test_shutdown_rebroadcast() {
1162         do_test_shutdown_rebroadcast(0);
1163         do_test_shutdown_rebroadcast(1);
1164         do_test_shutdown_rebroadcast(2);
1165 }
1166
1167 #[test]
1168 fn fake_network_test() {
1169         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1170         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1171         let chanmon_cfgs = create_chanmon_cfgs(4);
1172         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1173         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1174         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1175
1176         // Create some initial channels
1177         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1178         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1179         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1180
1181         // Rebalance the network a bit by relaying one payment through all the channels...
1182         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1183         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1184         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1185         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1186
1187         // Send some more payments
1188         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1189         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1190         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1191
1192         // Test failure packets
1193         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1194         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1195
1196         // Add a new channel that skips 3
1197         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1198
1199         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1200         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1201         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1202         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1203         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1204         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1205         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1206
1207         // Do some rebalance loop payments, simultaneously
1208         let mut hops = Vec::with_capacity(3);
1209         hops.push(RouteHop {
1210                 pubkey: nodes[2].node.get_our_node_id(),
1211                 node_features: NodeFeatures::empty(),
1212                 short_channel_id: chan_2.0.contents.short_channel_id,
1213                 channel_features: ChannelFeatures::empty(),
1214                 fee_msat: 0,
1215                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1216         });
1217         hops.push(RouteHop {
1218                 pubkey: nodes[3].node.get_our_node_id(),
1219                 node_features: NodeFeatures::empty(),
1220                 short_channel_id: chan_3.0.contents.short_channel_id,
1221                 channel_features: ChannelFeatures::empty(),
1222                 fee_msat: 0,
1223                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1224         });
1225         hops.push(RouteHop {
1226                 pubkey: nodes[1].node.get_our_node_id(),
1227                 node_features: NodeFeatures::empty(),
1228                 short_channel_id: chan_4.0.contents.short_channel_id,
1229                 channel_features: ChannelFeatures::empty(),
1230                 fee_msat: 1000000,
1231                 cltv_expiry_delta: TEST_FINAL_CLTV,
1232         });
1233         hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1234         hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1235         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1236
1237         let mut hops = Vec::with_capacity(3);
1238         hops.push(RouteHop {
1239                 pubkey: nodes[3].node.get_our_node_id(),
1240                 node_features: NodeFeatures::empty(),
1241                 short_channel_id: chan_4.0.contents.short_channel_id,
1242                 channel_features: ChannelFeatures::empty(),
1243                 fee_msat: 0,
1244                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1245         });
1246         hops.push(RouteHop {
1247                 pubkey: nodes[2].node.get_our_node_id(),
1248                 node_features: NodeFeatures::empty(),
1249                 short_channel_id: chan_3.0.contents.short_channel_id,
1250                 channel_features: ChannelFeatures::empty(),
1251                 fee_msat: 0,
1252                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1253         });
1254         hops.push(RouteHop {
1255                 pubkey: nodes[1].node.get_our_node_id(),
1256                 node_features: NodeFeatures::empty(),
1257                 short_channel_id: chan_2.0.contents.short_channel_id,
1258                 channel_features: ChannelFeatures::empty(),
1259                 fee_msat: 1000000,
1260                 cltv_expiry_delta: TEST_FINAL_CLTV,
1261         });
1262         hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1263         hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1264         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1265
1266         // Claim the rebalances...
1267         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1268         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1269
1270         // Add a duplicate new channel from 2 to 4
1271         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1272
1273         // Send some payments across both channels
1274         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1275         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1276         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1277
1278
1279         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1280         let events = nodes[0].node.get_and_clear_pending_msg_events();
1281         assert_eq!(events.len(), 0);
1282         nodes[0].logger.assert_log_regex("lightning::ln::channelmanager".to_string(), regex::Regex::new(r"Cannot send value that would put us over the max HTLC value in flight our peer will accept \(\d+\)").unwrap(), 1);
1283
1284         //TODO: Test that routes work again here as we've been notified that the channel is full
1285
1286         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1287         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1288         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1289
1290         // Close down the channels...
1291         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1292         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1293         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1294         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1295         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1296 }
1297
1298 #[test]
1299 fn holding_cell_htlc_counting() {
1300         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1301         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1302         // commitment dance rounds.
1303         let chanmon_cfgs = create_chanmon_cfgs(3);
1304         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1305         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1306         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1307         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1308         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
1309         let logger = test_utils::TestLogger::new();
1310
1311         let mut payments = Vec::new();
1312         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1313                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1314                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1315                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1316                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1317                 payments.push((payment_preimage, payment_hash));
1318         }
1319         check_added_monitors!(nodes[1], 1);
1320
1321         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1322         assert_eq!(events.len(), 1);
1323         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1324         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1325
1326         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1327         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1328         // another HTLC.
1329         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1330         {
1331                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1332                 let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1333                 unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { ref err },
1334                         assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
1335                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1336                 nodes[1].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1337         }
1338
1339         // This should also be true if we try to forward a payment.
1340         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1341         {
1342                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1343                 let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV, &logger).unwrap();
1344                 nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1345                 check_added_monitors!(nodes[0], 1);
1346         }
1347
1348         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1349         assert_eq!(events.len(), 1);
1350         let payment_event = SendEvent::from_event(events.pop().unwrap());
1351         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1352
1353         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1354         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1355         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1356         // fails), the second will process the resulting failure and fail the HTLC backward.
1357         expect_pending_htlcs_forwardable!(nodes[1]);
1358         expect_pending_htlcs_forwardable!(nodes[1]);
1359         check_added_monitors!(nodes[1], 1);
1360
1361         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1362         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1363         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1364
1365         let events = nodes[0].node.get_and_clear_pending_msg_events();
1366         assert_eq!(events.len(), 1);
1367         match events[0] {
1368                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1369                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1370                 },
1371                 _ => panic!("Unexpected event"),
1372         }
1373
1374         expect_payment_failed!(nodes[0], payment_hash_2, false);
1375
1376         // Now forward all the pending HTLCs and claim them back
1377         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1378         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1379         check_added_monitors!(nodes[2], 1);
1380
1381         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1382         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1383         check_added_monitors!(nodes[1], 1);
1384         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1385
1386         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1387         check_added_monitors!(nodes[1], 1);
1388         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1389
1390         for ref update in as_updates.update_add_htlcs.iter() {
1391                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1392         }
1393         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1394         check_added_monitors!(nodes[2], 1);
1395         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1396         check_added_monitors!(nodes[2], 1);
1397         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1398
1399         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1400         check_added_monitors!(nodes[1], 1);
1401         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1402         check_added_monitors!(nodes[1], 1);
1403         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1404
1405         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1406         check_added_monitors!(nodes[2], 1);
1407
1408         expect_pending_htlcs_forwardable!(nodes[2]);
1409
1410         let events = nodes[2].node.get_and_clear_pending_events();
1411         assert_eq!(events.len(), payments.len());
1412         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1413                 match event {
1414                         &Event::PaymentReceived { ref payment_hash, .. } => {
1415                                 assert_eq!(*payment_hash, *hash);
1416                         },
1417                         _ => panic!("Unexpected event"),
1418                 };
1419         }
1420
1421         for (preimage, _) in payments.drain(..) {
1422                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1423         }
1424
1425         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1426 }
1427
1428 #[test]
1429 fn duplicate_htlc_test() {
1430         // Test that we accept duplicate payment_hash HTLCs across the network and that
1431         // claiming/failing them are all separate and don't affect each other
1432         let chanmon_cfgs = create_chanmon_cfgs(6);
1433         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1434         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1435         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1436
1437         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1438         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
1439         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known());
1440         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
1441         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
1442         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
1443
1444         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1445
1446         *nodes[0].network_payment_count.borrow_mut() -= 1;
1447         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1448
1449         *nodes[0].network_payment_count.borrow_mut() -= 1;
1450         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1451
1452         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1453         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1454         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1455 }
1456
1457 #[test]
1458 fn test_duplicate_htlc_different_direction_onchain() {
1459         // Test that ChannelMonitor doesn't generate 2 preimage txn
1460         // when we have 2 HTLCs with same preimage that go across a node
1461         // in opposite directions.
1462         let chanmon_cfgs = create_chanmon_cfgs(2);
1463         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1464         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1465         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1466
1467         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
1468         let logger = test_utils::TestLogger::new();
1469
1470         // balancing
1471         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1472
1473         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1474
1475         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1476         let route = get_route(&nodes[1].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV, &logger).unwrap();
1477         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1478
1479         // Provide preimage to node 0 by claiming payment
1480         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1481         check_added_monitors!(nodes[0], 1);
1482
1483         // Broadcast node 1 commitment txn
1484         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1485
1486         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1487         let mut has_both_htlcs = 0; // check htlcs match ones committed
1488         for outp in remote_txn[0].output.iter() {
1489                 if outp.value == 800_000 / 1000 {
1490                         has_both_htlcs += 1;
1491                 } else if outp.value == 900_000 / 1000 {
1492                         has_both_htlcs += 1;
1493                 }
1494         }
1495         assert_eq!(has_both_htlcs, 2);
1496
1497         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1498         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1499         check_added_monitors!(nodes[0], 1);
1500
1501         // Check we only broadcast 1 timeout tx
1502         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1503         let htlc_pair = if claim_txn[0].output[0].value == 800_000 / 1000 { (claim_txn[0].clone(), claim_txn[1].clone()) } else { (claim_txn[1].clone(), claim_txn[0].clone()) };
1504         assert_eq!(claim_txn.len(), 5);
1505         check_spends!(claim_txn[2], chan_1.3);
1506         check_spends!(claim_txn[3], claim_txn[2]);
1507         assert_eq!(htlc_pair.0.input.len(), 1);
1508         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1509         check_spends!(htlc_pair.0, remote_txn[0]);
1510         assert_eq!(htlc_pair.1.input.len(), 1);
1511         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1512         check_spends!(htlc_pair.1, remote_txn[0]);
1513
1514         let events = nodes[0].node.get_and_clear_pending_msg_events();
1515         assert_eq!(events.len(), 2);
1516         for e in events {
1517                 match e {
1518                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1519                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, .. } } => {
1520                                 assert!(update_add_htlcs.is_empty());
1521                                 assert!(update_fail_htlcs.is_empty());
1522                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1523                                 assert!(update_fail_malformed_htlcs.is_empty());
1524                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1525                         },
1526                         _ => panic!("Unexpected event"),
1527                 }
1528         }
1529 }
1530
1531 #[test]
1532 fn test_basic_channel_reserve() {
1533         let chanmon_cfgs = create_chanmon_cfgs(2);
1534         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1535         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1536         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1537         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1538         let logger = test_utils::TestLogger::new();
1539
1540         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1541         let channel_reserve = chan_stat.channel_reserve_msat;
1542
1543         // The 2* and +1 are for the fee spike reserve.
1544         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
1545         let commit_tx_fee = 2 * commit_tx_fee_msat(get_feerate!(nodes[0], chan.2), 1 + 1);
1546         let max_can_send = 5000000 - channel_reserve - commit_tx_fee;
1547         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1548         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), max_can_send + 1, TEST_FINAL_CLTV, &logger).unwrap();
1549         let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
1550         match err {
1551                 PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
1552                         match &fails[0] {
1553                                 &APIError::ChannelUnavailable{ref err} =>
1554                                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
1555                                 _ => panic!("Unexpected error variant"),
1556                         }
1557                 },
1558                 _ => panic!("Unexpected error variant"),
1559         }
1560         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1561         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us under local channel reserve value".to_string(), 1);
1562
1563         send_payment(&nodes[0], &vec![&nodes[1]], max_can_send, max_can_send);
1564 }
1565
1566 #[test]
1567 fn test_fee_spike_violation_fails_htlc() {
1568         let chanmon_cfgs = create_chanmon_cfgs(2);
1569         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1570         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1571         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1572         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1573         let logger = test_utils::TestLogger::new();
1574
1575         macro_rules! get_route_and_payment_hash {
1576                 ($recv_value: expr) => {{
1577                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1578                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler.network_graph.read().unwrap();
1579                         let route = get_route(&nodes[0].node.get_our_node_id(), net_graph_msg_handler, &nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV, &logger).unwrap();
1580                         (route, payment_hash, payment_preimage)
1581                 }}
1582         };
1583
1584         let (route, payment_hash, _) = get_route_and_payment_hash!(3460001);
1585         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1586         let secp_ctx = Secp256k1::new();
1587         let session_priv = SecretKey::from_slice(&[42; 32]).expect("RNG is bad!");
1588
1589         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1590
1591         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1592         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3460001, &None, cur_height).unwrap();
1593         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1594         let msg = msgs::UpdateAddHTLC {
1595                 channel_id: chan.2,
1596                 htlc_id: 0,
1597                 amount_msat: htlc_msat,
1598                 payment_hash: payment_hash,
1599                 cltv_expiry: htlc_cltv,
1600                 onion_routing_packet: onion_packet,
1601         };
1602
1603         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1604
1605         // Now manually create the commitment_signed message corresponding to the update_add
1606         // nodes[0] just sent. In the code for construction of this message, "local" refers
1607         // to the sender of the message, and "remote" refers to the receiver.
1608
1609         let feerate_per_kw = get_feerate!(nodes[0], chan.2);
1610
1611         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
1612
1613         // Get the EnforcingChannelKeys for each channel, which will be used to (1) get the keys
1614         // needed to sign the new commitment tx and (2) sign the new commitment tx.
1615         let (local_revocation_basepoint, local_htlc_basepoint, local_payment_point, local_secret, local_secret2) = {
1616                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
1617                 let local_chan = chan_lock.by_id.get(&chan.2).unwrap();
1618                 let chan_keys = local_chan.get_local_keys();
1619                 let pubkeys = chan_keys.pubkeys();
1620                 (pubkeys.revocation_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1621                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER), chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2))
1622         };
1623         let (remote_delayed_payment_basepoint, remote_htlc_basepoint, remote_payment_point, remote_secret1) = {
1624                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
1625                 let remote_chan = chan_lock.by_id.get(&chan.2).unwrap();
1626                 let chan_keys = remote_chan.get_local_keys();
1627                 let pubkeys = chan_keys.pubkeys();
1628                 (pubkeys.delayed_payment_basepoint, pubkeys.htlc_basepoint, pubkeys.payment_point,
1629                  chan_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 1))
1630         };
1631
1632         // Assemble the set of keys we can use for signatures for our commitment_signed message.
1633         let commitment_secret = SecretKey::from_slice(&remote_secret1).unwrap();
1634         let per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &commitment_secret);
1635         let commit_tx_keys = chan_utils::TxCreationKeys::new(&secp_ctx, &per_commitment_point, &remote_delayed_payment_basepoint,
1636                 &remote_htlc_basepoint, &local_revocation_basepoint, &local_htlc_basepoint).unwrap();
1637
1638         // Build the remote commitment transaction so we can sign it, and then later use the
1639         // signature for the commitment_signed message.
1640         let local_chan_balance = 1313;
1641         let static_payment_pk = local_payment_point.serialize();
1642         let remote_commit_tx_output = TxOut {
1643                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1644                                                              .push_slice(&WPubkeyHash::hash(&static_payment_pk)[..])
1645                                                              .into_script(),
1646                 value: local_chan_balance as u64
1647         };
1648
1649         let local_commit_tx_output = TxOut {
1650                 script_pubkey: chan_utils::get_revokeable_redeemscript(&commit_tx_keys.revocation_key,
1651                                                                                BREAKDOWN_TIMEOUT,
1652                                                                                &commit_tx_keys.a_delayed_payment_key).to_v0_p2wsh(),
1653                                 value: 95000,
1654         };
1655
1656         let accepted_htlc_info = chan_utils::HTLCOutputInCommitment {
1657                 offered: false,
1658                 amount_msat: 3460001,
1659                 cltv_expiry: htlc_cltv,
1660                 payment_hash: payment_hash,
1661                 transaction_output_index: Some(1),
1662         };
1663
1664         let htlc_output = TxOut {
1665                 script_pubkey: chan_utils::get_htlc_redeemscript(&accepted_htlc_info, &commit_tx_keys).to_v0_p2wsh(),
1666                 value: 3460001 / 1000
1667         };
1668
1669         let commit_tx_obscure_factor = {
1670                 let mut sha = Sha256::engine();
1671                 let remote_payment_point = &remote_payment_point.serialize();
1672                 sha.input(&local_payment_point.serialize());
1673                 sha.input(remote_payment_point);
1674                 let res = Sha256::from_engine(sha).into_inner();
1675
1676                 ((res[26] as u64) << 5*8) |
1677                 ((res[27] as u64) << 4*8) |
1678                 ((res[28] as u64) << 3*8) |
1679                 ((res[29] as u64) << 2*8) |
1680                 ((res[30] as u64) << 1*8) |
1681                 ((res[31] as u64) << 0*8)
1682         };
1683         let commitment_number = 1;
1684         let obscured_commitment_transaction_number = commit_tx_obscure_factor ^ commitment_number;
1685         let lock_time = ((0x20 as u32) << 8*3) | ((obscured_commitment_transaction_number & 0xffffffu64) as u32);
1686         let input = TxIn {
1687                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
1688                 script_sig: Script::new(),
1689                 sequence: ((0x80 as u32) << 8*3) | ((obscured_commitment_transaction_number >> 3*8) as u32),
1690                 witness: Vec::new(),
1691         };
1692
1693         let commit_tx = Transaction {
1694                 version: 2,
1695                 lock_time,
1696                 input: vec![input],
1697                 output: vec![remote_commit_tx_output, htlc_output, local_commit_tx_output],
1698         };
1699         let res = {
1700                 let local_chan_lock = nodes[0].node.channel_state.lock().unwrap();
1701                 let local_chan = local_chan_lock.by_id.get(&chan.2).unwrap();
1702                 let local_chan_keys = local_chan.get_local_keys();
1703                 local_chan_keys.sign_remote_commitment(feerate_per_kw, &commit_tx, &commit_tx_keys, &[&accepted_htlc_info], &secp_ctx).unwrap()
1704         };
1705
1706         let commit_signed_msg = msgs::CommitmentSigned {
1707                 channel_id: chan.2,
1708                 signature: res.0,
1709                 htlc_signatures: res.1
1710         };
1711
1712         // Send the commitment_signed message to the nodes[1].
1713         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commit_signed_msg);
1714         let _ = nodes[1].node.get_and_clear_pending_msg_events();
1715
1716         // Send the RAA to nodes[1].
1717         let per_commitment_secret = local_secret;
1718         let next_secret = SecretKey::from_slice(&local_secret2).unwrap();
1719         let next_per_commitment_point = PublicKey::from_secret_key(&secp_ctx, &next_secret);
1720         let raa_msg = msgs::RevokeAndACK{ channel_id: chan.2, per_commitment_secret, next_per_commitment_point};
1721         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &raa_msg);
1722
1723         let events = nodes[1].node.get_and_clear_pending_msg_events();
1724         assert_eq!(events.len(), 1);
1725         // Make sure the HTLC failed in the way we expect.
1726         match events[0] {
1727                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, .. }, .. } => {
1728                         assert_eq!(update_fail_htlcs.len(), 1);
1729                         update_fail_htlcs[0].clone()
1730                 },
1731                 _ => panic!("Unexpected event"),
1732         };
1733         nodes[1].logger.assert_log("lightning::ln::channel".to_string(), "Attempting to fail HTLC due to fee spike buffer violation".to_string(), 1);
1734
1735         check_added_monitors!(nodes[1], 2);
1736 }
1737
1738 #[test]
1739 fn test_chan_reserve_violation_outbound_htlc_inbound_chan() {
1740         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1741         // Set the fee rate for the channel very high, to the point where the fundee
1742         // sending any amount would result in a channel reserve violation. In this test
1743         // we check that we would be prevented from sending an HTLC in this situation.
1744         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1745         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1746         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1747         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1748         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1749         let _ = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1750         let logger = test_utils::TestLogger::new();
1751
1752         macro_rules! get_route_and_payment_hash {
1753                 ($recv_value: expr) => {{
1754                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1755                         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
1756                         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();
1757                         (route, payment_hash, payment_preimage)
1758                 }}
1759         };
1760
1761         let (route, our_payment_hash, _) = get_route_and_payment_hash!(1000);
1762         unwrap_send_err!(nodes[1].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1763                 assert_eq!(err, "Cannot send value that would put them under remote channel reserve value"));
1764         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1765         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);
1766 }
1767
1768 #[test]
1769 fn test_chan_reserve_violation_inbound_htlc_outbound_channel() {
1770         let mut chanmon_cfgs = create_chanmon_cfgs(2);
1771         // Set the fee rate for the channel very high, to the point where the funder
1772         // receiving 1 update_add_htlc would result in them closing the channel due
1773         // to channel reserve violation. This close could also happen if the fee went
1774         // up a more realistic amount, but many HTLCs were outstanding at the time of
1775         // the update_add_htlc.
1776         chanmon_cfgs[0].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1777         chanmon_cfgs[1].fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 6000 };
1778         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1779         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1780         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1781         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1782         let logger = test_utils::TestLogger::new();
1783
1784         macro_rules! get_route_and_payment_hash {
1785                 ($recv_value: expr) => {{
1786                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[1]);
1787                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1788                         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();
1789                         (route, payment_hash, payment_preimage)
1790                 }}
1791         };
1792
1793         let (route, payment_hash, _) = get_route_and_payment_hash!(1000);
1794         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1795         let secp_ctx = Secp256k1::new();
1796         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1797         let cur_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1798         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1799         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 1000, &None, cur_height).unwrap();
1800         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
1801         let msg = msgs::UpdateAddHTLC {
1802                 channel_id: chan.2,
1803                 htlc_id: 1,
1804                 amount_msat: htlc_msat + 1,
1805                 payment_hash: payment_hash,
1806                 cltv_expiry: htlc_cltv,
1807                 onion_routing_packet: onion_packet,
1808         };
1809
1810         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &msg);
1811         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1812         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);
1813         assert_eq!(nodes[0].node.list_channels().len(), 0);
1814         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
1815         assert_eq!(err_msg.data, "Cannot receive value that would put us under local channel reserve value");
1816         check_added_monitors!(nodes[0], 1);
1817 }
1818
1819 #[test]
1820 fn test_chan_reserve_violation_inbound_htlc_inbound_chan() {
1821         let chanmon_cfgs = create_chanmon_cfgs(3);
1822         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1823         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1824         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1825         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1826         let _ = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
1827         let logger = test_utils::TestLogger::new();
1828
1829         macro_rules! get_route_and_payment_hash {
1830                 ($recv_value: expr) => {{
1831                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1832                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1833                         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();
1834                         (route, payment_hash, payment_preimage)
1835                 }}
1836         };
1837
1838         let feemsat = 239;
1839         let total_routing_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1840         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
1841         let feerate = get_feerate!(nodes[0], chan.2);
1842
1843         // Add a 2* and +1 for the fee spike reserve.
1844         let commit_tx_fee_2_htlc = 2*commit_tx_fee_msat(feerate, 2 + 1);
1845         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;
1846         let amt_msat_1 = recv_value_1 + total_routing_fee_msat;
1847
1848         // Add a pending HTLC.
1849         let (route_1, our_payment_hash_1, _) = get_route_and_payment_hash!(amt_msat_1);
1850         let payment_event_1 = {
1851                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1852                 check_added_monitors!(nodes[0], 1);
1853
1854                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1855                 assert_eq!(events.len(), 1);
1856                 SendEvent::from_event(events.remove(0))
1857         };
1858         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1859
1860         // Attempt to trigger a channel reserve violation --> payment failure.
1861         let commit_tx_fee_2_htlcs = commit_tx_fee_msat(feerate, 2);
1862         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;
1863         let amt_msat_2 = recv_value_2 + total_routing_fee_msat;
1864         let (route_2, _, _) = get_route_and_payment_hash!(amt_msat_2);
1865
1866         // Need to manually create the update_add_htlc message to go around the channel reserve check in send_htlc()
1867         let secp_ctx = Secp256k1::new();
1868         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
1869         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1870         let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route_2.paths[0], &session_priv).unwrap();
1871         let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route_2.paths[0], recv_value_2, &None, cur_height).unwrap();
1872         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash_1);
1873         let msg = msgs::UpdateAddHTLC {
1874                 channel_id: chan.2,
1875                 htlc_id: 1,
1876                 amount_msat: htlc_msat + 1,
1877                 payment_hash: our_payment_hash_1,
1878                 cltv_expiry: htlc_cltv,
1879                 onion_routing_packet: onion_packet,
1880         };
1881
1882         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1883         // Check that the payment failed and the channel is closed in response to the malicious UpdateAdd.
1884         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote HTLC add would put them under remote reserve value".to_string(), 1);
1885         assert_eq!(nodes[1].node.list_channels().len(), 1);
1886         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1887         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
1888         check_added_monitors!(nodes[1], 1);
1889 }
1890
1891 fn commit_tx_fee_msat(feerate: u32, num_htlcs: u64) -> u64 {
1892         (COMMITMENT_TX_BASE_WEIGHT + num_htlcs * COMMITMENT_TX_WEIGHT_PER_HTLC) * feerate as u64 / 1000 * 1000
1893 }
1894
1895 #[test]
1896 fn test_channel_reserve_holding_cell_htlcs() {
1897         let chanmon_cfgs = create_chanmon_cfgs(3);
1898         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1899         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1900         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1901         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1902         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 190000, 1001, InitFeatures::known(), InitFeatures::known());
1903         let logger = test_utils::TestLogger::new();
1904
1905         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1906         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1907
1908         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1909         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1910
1911         macro_rules! get_route_and_payment_hash {
1912                 ($recv_value: expr) => {{
1913                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1914                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
1915                         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();
1916                         (route, payment_hash, payment_preimage)
1917                 }}
1918         };
1919
1920         macro_rules! expect_forward {
1921                 ($node: expr) => {{
1922                         let mut events = $node.node.get_and_clear_pending_msg_events();
1923                         assert_eq!(events.len(), 1);
1924                         check_added_monitors!($node, 1);
1925                         let payment_event = SendEvent::from_event(events.remove(0));
1926                         payment_event
1927                 }}
1928         }
1929
1930         let feemsat = 239; // somehow we know?
1931         let total_fee_msat = (nodes.len() - 2) as u64 * feemsat;
1932         let feerate = get_feerate!(nodes[0], chan_1.2);
1933
1934         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1935
1936         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1937         {
1938                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1939                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1940                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
1941                         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)));
1942                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1943                 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);
1944         }
1945
1946         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1947         // nodes[0]'s wealth
1948         loop {
1949                 let amt_msat = recv_value_0 + total_fee_msat;
1950                 // 3 for the 3 HTLCs that will be sent, 2* and +1 for the fee spike reserve.
1951                 // Also, ensure that each payment has enough to be over the dust limit to
1952                 // ensure it'll be included in each commit tx fee calculation.
1953                 let commit_tx_fee_all_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
1954                 let ensure_htlc_amounts_above_dust_buffer = 3 * (stat01.their_dust_limit_msat + 1000);
1955                 if stat01.value_to_self_msat < stat01.channel_reserve_msat + commit_tx_fee_all_htlcs + ensure_htlc_amounts_above_dust_buffer + amt_msat {
1956                         break;
1957                 }
1958                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1959
1960                 let (stat01_, stat11_, stat12_, stat22_) = (
1961                         get_channel_value_stat!(nodes[0], chan_1.2),
1962                         get_channel_value_stat!(nodes[1], chan_1.2),
1963                         get_channel_value_stat!(nodes[1], chan_2.2),
1964                         get_channel_value_stat!(nodes[2], chan_2.2),
1965                 );
1966
1967                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1968                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1969                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1970                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1971                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1972         }
1973
1974         // adding pending output.
1975         // 2* and +1 HTLCs on the commit tx fee for the fee spike reserve.
1976         // The reason we're dividing by two here is as follows: the dividend is the total outbound liquidity
1977         // after fees, the channel reserve, and the fee spike buffer are removed. We eventually want to
1978         // divide this quantity into 3 portions, that will each be sent in an HTLC. This allows us
1979         // to test channel channel reserve policy at the edges of what amount is sendable, i.e.
1980         // cases where 1 msat over X amount will cause a payment failure, but anything less than
1981         // that can be sent successfully. So, dividing by two is a somewhat arbitrary way of getting
1982         // the amount of the first of these aforementioned 3 payments. The reason we split into 3 payments
1983         // is to test the behavior of the holding cell with respect to channel reserve and commit tx fee
1984         // policy.
1985         let commit_tx_fee_2_htlcs = 2*commit_tx_fee_msat(feerate, 2 + 1);
1986         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs)/2;
1987         let amt_msat_1 = recv_value_1 + total_fee_msat;
1988
1989         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1990         let payment_event_1 = {
1991                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1992                 check_added_monitors!(nodes[0], 1);
1993
1994                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1995                 assert_eq!(events.len(), 1);
1996                 SendEvent::from_event(events.remove(0))
1997         };
1998         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1999
2000         // channel reserve test with htlc pending output > 0
2001         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat - commit_tx_fee_2_htlcs;
2002         {
2003                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
2004                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2005                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)));
2006                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2007         }
2008
2009         // split the rest to test holding cell
2010         let commit_tx_fee_3_htlcs = 2*commit_tx_fee_msat(feerate, 3 + 1);
2011         let additional_htlc_cost_msat = commit_tx_fee_3_htlcs - commit_tx_fee_2_htlcs;
2012         let recv_value_21 = recv_value_2/2 - additional_htlc_cost_msat/2;
2013         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat - additional_htlc_cost_msat;
2014         {
2015                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
2016                 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);
2017         }
2018
2019         // now see if they go through on both sides
2020         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
2021         // but this will stuck in the holding cell
2022         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
2023         check_added_monitors!(nodes[0], 0);
2024         let events = nodes[0].node.get_and_clear_pending_events();
2025         assert_eq!(events.len(), 0);
2026
2027         // test with outbound holding cell amount > 0
2028         {
2029                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
2030                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
2031                         assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)));
2032                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2033                 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);
2034         }
2035
2036         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
2037         // this will also stuck in the holding cell
2038         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
2039         check_added_monitors!(nodes[0], 0);
2040         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
2041         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2042
2043         // flush the pending htlc
2044         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
2045         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2046         check_added_monitors!(nodes[1], 1);
2047
2048         // the pending htlc should be promoted to committed
2049         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
2050         check_added_monitors!(nodes[0], 1);
2051         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2052
2053         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
2054         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2055         // No commitment_signed so get_event_msg's assert(len == 1) passes
2056         check_added_monitors!(nodes[0], 1);
2057
2058         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
2059         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2060         check_added_monitors!(nodes[1], 1);
2061
2062         expect_pending_htlcs_forwardable!(nodes[1]);
2063
2064         let ref payment_event_11 = expect_forward!(nodes[1]);
2065         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
2066         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
2067
2068         expect_pending_htlcs_forwardable!(nodes[2]);
2069         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
2070
2071         // flush the htlcs in the holding cell
2072         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
2073         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
2074         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
2075         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
2076         expect_pending_htlcs_forwardable!(nodes[1]);
2077
2078         let ref payment_event_3 = expect_forward!(nodes[1]);
2079         assert_eq!(payment_event_3.msgs.len(), 2);
2080         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
2081         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
2082
2083         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
2084         expect_pending_htlcs_forwardable!(nodes[2]);
2085
2086         let events = nodes[2].node.get_and_clear_pending_events();
2087         assert_eq!(events.len(), 2);
2088         match events[0] {
2089                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2090                         assert_eq!(our_payment_hash_21, *payment_hash);
2091                         assert_eq!(*payment_secret, None);
2092                         assert_eq!(recv_value_21, amt);
2093                 },
2094                 _ => panic!("Unexpected event"),
2095         }
2096         match events[1] {
2097                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
2098                         assert_eq!(our_payment_hash_22, *payment_hash);
2099                         assert_eq!(None, *payment_secret);
2100                         assert_eq!(recv_value_22, amt);
2101                 },
2102                 _ => panic!("Unexpected event"),
2103         }
2104
2105         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
2106         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
2107         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
2108
2109         let commit_tx_fee_0_htlcs = 2*commit_tx_fee_msat(feerate, 1);
2110         let recv_value_3 = commit_tx_fee_2_htlcs - commit_tx_fee_0_htlcs - total_fee_msat;
2111         {
2112                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_3 + 1);
2113                 let err = nodes[0].node.send_payment(&route, our_payment_hash, &None).err().unwrap();
2114                 match err {
2115                         PaymentSendFailure::AllFailedRetrySafe(ref fails) => {
2116                                 match &fails[0] {
2117                                         &APIError::ChannelUnavailable{ref err} =>
2118                                                 assert!(regex::Regex::new(r"Cannot send value that would put us under local channel reserve value \(\d+\)").unwrap().is_match(err)),
2119                                         _ => panic!("Unexpected error variant"),
2120                                 }
2121                         },
2122                         _ => panic!("Unexpected error variant"),
2123                 }
2124                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2125                 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);
2126         }
2127
2128         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_3, recv_value_3);
2129
2130         let commit_tx_fee_1_htlc = 2*commit_tx_fee_msat(feerate, 1 + 1);
2131         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);
2132         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
2133         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
2134         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat + commit_tx_fee_1_htlc);
2135
2136         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
2137         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22 + recv_value_3);
2138 }
2139
2140 #[test]
2141 fn channel_reserve_in_flight_removes() {
2142         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
2143         // can send to its counterparty, but due to update ordering, the other side may not yet have
2144         // considered those HTLCs fully removed.
2145         // This tests that we don't count HTLCs which will not be included in the next remote
2146         // commitment transaction towards the reserve value (as it implies no commitment transaction
2147         // will be generated which violates the remote reserve value).
2148         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
2149         // To test this we:
2150         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
2151         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
2152         //    you only consider the value of the first HTLC, it may not),
2153         //  * start routing a third HTLC from A to B,
2154         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
2155         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
2156         //  * deliver the first fulfill from B
2157         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
2158         //    claim,
2159         //  * deliver A's response CS and RAA.
2160         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
2161         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
2162         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
2163         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
2164         let chanmon_cfgs = create_chanmon_cfgs(2);
2165         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2166         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2167         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2168         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2169         let logger = test_utils::TestLogger::new();
2170
2171         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
2172         // Route the first two HTLCs.
2173         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
2174         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
2175
2176         // Start routing the third HTLC (this is just used to get everyone in the right state).
2177         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
2178         let send_1 = {
2179                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
2180                 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();
2181                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
2182                 check_added_monitors!(nodes[0], 1);
2183                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2184                 assert_eq!(events.len(), 1);
2185                 SendEvent::from_event(events.remove(0))
2186         };
2187
2188         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
2189         // initial fulfill/CS.
2190         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
2191         check_added_monitors!(nodes[1], 1);
2192         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2193
2194         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
2195         // remove the second HTLC when we send the HTLC back from B to A.
2196         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
2197         check_added_monitors!(nodes[1], 1);
2198         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2199
2200         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
2201         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
2202         check_added_monitors!(nodes[0], 1);
2203         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2204         expect_payment_sent!(nodes[0], payment_preimage_1);
2205
2206         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
2207         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
2208         check_added_monitors!(nodes[1], 1);
2209         // B is already AwaitingRAA, so cant generate a CS here
2210         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2211
2212         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2213         check_added_monitors!(nodes[1], 1);
2214         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2215
2216         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2217         check_added_monitors!(nodes[0], 1);
2218         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2219
2220         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2221         check_added_monitors!(nodes[1], 1);
2222         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2223
2224         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
2225         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
2226         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
2227         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
2228         // on-chain as necessary).
2229         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
2230         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
2231         check_added_monitors!(nodes[0], 1);
2232         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2233         expect_payment_sent!(nodes[0], payment_preimage_2);
2234
2235         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2236         check_added_monitors!(nodes[1], 1);
2237         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2238
2239         expect_pending_htlcs_forwardable!(nodes[1]);
2240         expect_payment_received!(nodes[1], payment_hash_3, 100000);
2241
2242         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
2243         // resolve the second HTLC from A's point of view.
2244         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2245         check_added_monitors!(nodes[0], 1);
2246         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2247
2248         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
2249         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
2250         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
2251         let send_2 = {
2252                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
2253                 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();
2254                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
2255                 check_added_monitors!(nodes[1], 1);
2256                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
2257                 assert_eq!(events.len(), 1);
2258                 SendEvent::from_event(events.remove(0))
2259         };
2260
2261         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
2262         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
2263         check_added_monitors!(nodes[0], 1);
2264         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2265
2266         // Now just resolve all the outstanding messages/HTLCs for completeness...
2267
2268         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2269         check_added_monitors!(nodes[1], 1);
2270         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2271
2272         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
2273         check_added_monitors!(nodes[1], 1);
2274
2275         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2276         check_added_monitors!(nodes[0], 1);
2277         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
2278
2279         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
2280         check_added_monitors!(nodes[1], 1);
2281         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
2282
2283         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
2284         check_added_monitors!(nodes[0], 1);
2285
2286         expect_pending_htlcs_forwardable!(nodes[0]);
2287         expect_payment_received!(nodes[0], payment_hash_4, 10000);
2288
2289         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
2290         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
2291 }
2292
2293 #[test]
2294 fn channel_monitor_network_test() {
2295         // Simple test which builds a network of ChannelManagers, connects them to each other, and
2296         // tests that ChannelMonitor is able to recover from various states.
2297         let chanmon_cfgs = create_chanmon_cfgs(5);
2298         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
2299         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
2300         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
2301
2302         // Create some initial channels
2303         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2304         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2305         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
2306         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
2307
2308         // Rebalance the network a bit by relaying one payment through all the channels...
2309         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2310         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2311         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2312         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
2313
2314         // Simple case with no pending HTLCs:
2315         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
2316         check_added_monitors!(nodes[1], 1);
2317         {
2318                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
2319                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2320                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2321                 check_added_monitors!(nodes[0], 1);
2322                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
2323         }
2324         get_announce_close_broadcast_events(&nodes, 0, 1);
2325         assert_eq!(nodes[0].node.list_channels().len(), 0);
2326         assert_eq!(nodes[1].node.list_channels().len(), 1);
2327
2328         // One pending HTLC is discarded by the force-close:
2329         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
2330
2331         // Simple case of one pending HTLC to HTLC-Timeout
2332         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
2333         check_added_monitors!(nodes[1], 1);
2334         {
2335                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
2336                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2337                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
2338                 check_added_monitors!(nodes[2], 1);
2339                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
2340         }
2341         get_announce_close_broadcast_events(&nodes, 1, 2);
2342         assert_eq!(nodes[1].node.list_channels().len(), 0);
2343         assert_eq!(nodes[2].node.list_channels().len(), 1);
2344
2345         macro_rules! claim_funds {
2346                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
2347                         {
2348                                 assert!($node.node.claim_funds($preimage, &None, $amount));
2349                                 check_added_monitors!($node, 1);
2350
2351                                 let events = $node.node.get_and_clear_pending_msg_events();
2352                                 assert_eq!(events.len(), 1);
2353                                 match events[0] {
2354                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2355                                                 assert!(update_add_htlcs.is_empty());
2356                                                 assert!(update_fail_htlcs.is_empty());
2357                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2358                                         },
2359                                         _ => panic!("Unexpected event"),
2360                                 };
2361                         }
2362                 }
2363         }
2364
2365         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2366         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2367         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2368         check_added_monitors!(nodes[2], 1);
2369         let node2_commitment_txid;
2370         {
2371                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2372                 node2_commitment_txid = node_txn[0].txid();
2373
2374                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2375                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2376
2377                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2378                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2379                 check_added_monitors!(nodes[3], 1);
2380
2381                 check_preimage_claim(&nodes[3], &node_txn);
2382         }
2383         get_announce_close_broadcast_events(&nodes, 2, 3);
2384         assert_eq!(nodes[2].node.list_channels().len(), 0);
2385         assert_eq!(nodes[3].node.list_channels().len(), 1);
2386
2387         { // Cheat and reset nodes[4]'s height to 1
2388                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2389                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2390         }
2391
2392         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2393         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2394         // One pending HTLC to time out:
2395         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2396         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2397         // buffer space).
2398
2399         {
2400                 let mut block = Block {
2401                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2402                         txdata: vec![],
2403                 };
2404                 nodes[3].block_notifier.block_connected(&block, 2);
2405                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2406                         block = Block {
2407                                 header: BlockHeader { version: 0x20000000, prev_blockhash: block.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2408                                 txdata: vec![],
2409                         };
2410                         nodes[3].block_notifier.block_connected(&block, i);
2411                 }
2412                 check_added_monitors!(nodes[3], 1);
2413
2414                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2415                 {
2416                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2417                         node_txn.retain(|tx| {
2418                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2419                                         false
2420                                 } else { true }
2421                         });
2422                 }
2423
2424                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2425
2426                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2427                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2428
2429                 block = Block {
2430                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2431                         txdata: vec![],
2432                 };
2433
2434                 nodes[4].block_notifier.block_connected(&block, 2);
2435                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2436                         block = Block {
2437                                 header: BlockHeader { version: 0x20000000, prev_blockhash: block.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2438                                 txdata: vec![],
2439                         };
2440                         nodes[4].block_notifier.block_connected(&block, i);
2441                 }
2442
2443                 check_added_monitors!(nodes[4], 1);
2444                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2445
2446                 block = Block {
2447                         header: BlockHeader { version: 0x20000000, prev_blockhash: block.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
2448                         txdata: vec![node_txn[0].clone()],
2449                 };
2450                 nodes[4].block_notifier.block_connected(&block, TEST_FINAL_CLTV - 5);
2451
2452                 check_preimage_claim(&nodes[4], &node_txn);
2453         }
2454         get_announce_close_broadcast_events(&nodes, 3, 4);
2455         assert_eq!(nodes[3].node.list_channels().len(), 0);
2456         assert_eq!(nodes[4].node.list_channels().len(), 0);
2457 }
2458
2459 #[test]
2460 fn test_justice_tx() {
2461         // Test justice txn built on revoked HTLC-Success tx, against both sides
2462         let mut alice_config = UserConfig::default();
2463         alice_config.channel_options.announced_channel = true;
2464         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2465         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2466         let mut bob_config = UserConfig::default();
2467         bob_config.channel_options.announced_channel = true;
2468         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2469         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2470         let user_cfgs = [Some(alice_config), Some(bob_config)];
2471         let chanmon_cfgs = create_chanmon_cfgs(2);
2472         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2473         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2474         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2475         // Create some new channels:
2476         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2477
2478         // A pending HTLC which will be revoked:
2479         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2480         // Get the will-be-revoked local txn from nodes[0]
2481         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2482         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2483         assert_eq!(revoked_local_txn[0].input.len(), 1);
2484         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2485         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2486         assert_eq!(revoked_local_txn[1].input.len(), 1);
2487         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2488         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2489         // Revoke the old state
2490         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2491
2492         {
2493                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2494                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2495                 {
2496                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2497                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2498                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2499
2500                         check_spends!(node_txn[0], revoked_local_txn[0]);
2501                         node_txn.swap_remove(0);
2502                         node_txn.truncate(1);
2503                 }
2504                 check_added_monitors!(nodes[1], 1);
2505                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2506
2507                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2508                 // Verify broadcast of revoked HTLC-timeout
2509                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2510                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2511                 check_added_monitors!(nodes[0], 1);
2512                 // Broadcast revoked HTLC-timeout on node 1
2513                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2514                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2515         }
2516         get_announce_close_broadcast_events(&nodes, 0, 1);
2517
2518         assert_eq!(nodes[0].node.list_channels().len(), 0);
2519         assert_eq!(nodes[1].node.list_channels().len(), 0);
2520
2521         // We test justice_tx build by A on B's revoked HTLC-Success tx
2522         // Create some new channels:
2523         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2524         {
2525                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2526                 node_txn.clear();
2527         }
2528
2529         // A pending HTLC which will be revoked:
2530         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2531         // Get the will-be-revoked local txn from B
2532         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2533         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2534         assert_eq!(revoked_local_txn[0].input.len(), 1);
2535         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2536         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2537         // Revoke the old state
2538         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2539         {
2540                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2541                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2542                 {
2543                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2544                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2545                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2546
2547                         check_spends!(node_txn[0], revoked_local_txn[0]);
2548                         node_txn.swap_remove(0);
2549                 }
2550                 check_added_monitors!(nodes[0], 1);
2551                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2552
2553                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2554                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2555                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2556                 check_added_monitors!(nodes[1], 1);
2557                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2558                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2559         }
2560         get_announce_close_broadcast_events(&nodes, 0, 1);
2561         assert_eq!(nodes[0].node.list_channels().len(), 0);
2562         assert_eq!(nodes[1].node.list_channels().len(), 0);
2563 }
2564
2565 #[test]
2566 fn revoked_output_claim() {
2567         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2568         // transaction is broadcast by its counterparty
2569         let chanmon_cfgs = create_chanmon_cfgs(2);
2570         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2571         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2572         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2573         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2574         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2575         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2576         assert_eq!(revoked_local_txn.len(), 1);
2577         // Only output is the full channel value back to nodes[0]:
2578         assert_eq!(revoked_local_txn[0].output.len(), 1);
2579         // Send a payment through, updating everyone's latest commitment txn
2580         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2581
2582         // Inform nodes[1] that nodes[0] broadcast a stale tx
2583         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2584         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2585         check_added_monitors!(nodes[1], 1);
2586         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2587         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2588
2589         check_spends!(node_txn[0], revoked_local_txn[0]);
2590         check_spends!(node_txn[1], chan_1.3);
2591
2592         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2593         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2594         get_announce_close_broadcast_events(&nodes, 0, 1);
2595         check_added_monitors!(nodes[0], 1)
2596 }
2597
2598 #[test]
2599 fn claim_htlc_outputs_shared_tx() {
2600         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2601         let chanmon_cfgs = create_chanmon_cfgs(2);
2602         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2603         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2604         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2605
2606         // Create some new channel:
2607         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2608
2609         // Rebalance the network to generate htlc in the two directions
2610         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2611         // 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
2612         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2613         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2614
2615         // Get the will-be-revoked local txn from node[0]
2616         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2617         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2618         assert_eq!(revoked_local_txn[0].input.len(), 1);
2619         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2620         assert_eq!(revoked_local_txn[1].input.len(), 1);
2621         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2622         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2623         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2624
2625         //Revoke the old state
2626         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2627
2628         {
2629                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2630                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2631                 check_added_monitors!(nodes[0], 1);
2632                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2633                 check_added_monitors!(nodes[1], 1);
2634                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2635                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2636
2637                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2638                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2639
2640                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2641                 check_spends!(node_txn[0], revoked_local_txn[0]);
2642
2643                 let mut witness_lens = BTreeSet::new();
2644                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2645                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2646                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2647                 assert_eq!(witness_lens.len(), 3);
2648                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2649                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2650                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2651
2652                 // Next nodes[1] broadcasts its current local tx state:
2653                 assert_eq!(node_txn[1].input.len(), 1);
2654                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2655
2656                 assert_eq!(node_txn[2].input.len(), 1);
2657                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2658                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2659                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2660                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2661                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2662         }
2663         get_announce_close_broadcast_events(&nodes, 0, 1);
2664         assert_eq!(nodes[0].node.list_channels().len(), 0);
2665         assert_eq!(nodes[1].node.list_channels().len(), 0);
2666 }
2667
2668 #[test]
2669 fn claim_htlc_outputs_single_tx() {
2670         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2671         let chanmon_cfgs = create_chanmon_cfgs(2);
2672         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2673         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2674         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2675
2676         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2677
2678         // Rebalance the network to generate htlc in the two directions
2679         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2680         // 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
2681         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2682         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2683         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2684
2685         // Get the will-be-revoked local txn from node[0]
2686         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2687
2688         //Revoke the old state
2689         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2690
2691         {
2692                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2693                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2694                 check_added_monitors!(nodes[0], 1);
2695                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2696                 check_added_monitors!(nodes[1], 1);
2697                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2698
2699                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2700                 expect_payment_failed!(nodes[1], payment_hash_2, true);
2701
2702                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2703                 assert_eq!(node_txn.len(), 9);
2704                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2705                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2706                 // 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)
2707                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2708
2709                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2710                 assert_eq!(node_txn[2].input.len(), 1);
2711                 check_spends!(node_txn[2], chan_1.3);
2712                 assert_eq!(node_txn[3].input.len(), 1);
2713                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2714                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2715                 check_spends!(node_txn[3], node_txn[2]);
2716
2717                 // Justice transactions are indices 1-2-4
2718                 assert_eq!(node_txn[0].input.len(), 1);
2719                 assert_eq!(node_txn[1].input.len(), 1);
2720                 assert_eq!(node_txn[4].input.len(), 1);
2721
2722                 check_spends!(node_txn[0], revoked_local_txn[0]);
2723                 check_spends!(node_txn[1], revoked_local_txn[0]);
2724                 check_spends!(node_txn[4], revoked_local_txn[0]);
2725
2726                 let mut witness_lens = BTreeSet::new();
2727                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2728                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2729                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2730                 assert_eq!(witness_lens.len(), 3);
2731                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2732                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2733                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2734         }
2735         get_announce_close_broadcast_events(&nodes, 0, 1);
2736         assert_eq!(nodes[0].node.list_channels().len(), 0);
2737         assert_eq!(nodes[1].node.list_channels().len(), 0);
2738 }
2739
2740 #[test]
2741 fn test_htlc_on_chain_success() {
2742         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2743         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2744         // broadcasting the right event to other nodes in payment path.
2745         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2746         // A --------------------> B ----------------------> C (preimage)
2747         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2748         // commitment transaction was broadcast.
2749         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2750         // towards B.
2751         // B should be able to claim via preimage if A then broadcasts its local tx.
2752         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2753         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2754         // PaymentSent event).
2755
2756         let chanmon_cfgs = create_chanmon_cfgs(3);
2757         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2758         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2759         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2760
2761         // Create some initial channels
2762         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2763         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2764
2765         // Rebalance the network a bit by relaying one payment through all the channels...
2766         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2767         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2768
2769         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2770         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2771         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2772
2773         // Broadcast legit commitment tx from C on B's chain
2774         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2775         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2776         assert_eq!(commitment_tx.len(), 1);
2777         check_spends!(commitment_tx[0], chan_2.3);
2778         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2779         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2780         check_added_monitors!(nodes[2], 2);
2781         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2782         assert!(updates.update_add_htlcs.is_empty());
2783         assert!(updates.update_fail_htlcs.is_empty());
2784         assert!(updates.update_fail_malformed_htlcs.is_empty());
2785         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2786
2787         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2788         check_closed_broadcast!(nodes[2], false);
2789         check_added_monitors!(nodes[2], 1);
2790         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)
2791         assert_eq!(node_txn.len(), 5);
2792         assert_eq!(node_txn[0], node_txn[3]);
2793         assert_eq!(node_txn[1], node_txn[4]);
2794         assert_eq!(node_txn[2], commitment_tx[0]);
2795         check_spends!(node_txn[0], commitment_tx[0]);
2796         check_spends!(node_txn[1], commitment_tx[0]);
2797         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2798         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2799         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2800         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2801         assert_eq!(node_txn[0].lock_time, 0);
2802         assert_eq!(node_txn[1].lock_time, 0);
2803
2804         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2805         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2806         {
2807                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2808                 assert_eq!(added_monitors.len(), 1);
2809                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2810                 added_monitors.clear();
2811         }
2812         let events = nodes[1].node.get_and_clear_pending_msg_events();
2813         {
2814                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2815                 assert_eq!(added_monitors.len(), 2);
2816                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2817                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2818                 added_monitors.clear();
2819         }
2820         assert_eq!(events.len(), 2);
2821         match events[0] {
2822                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2823                 _ => panic!("Unexpected event"),
2824         }
2825         match events[1] {
2826                 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, .. } } => {
2827                         assert!(update_add_htlcs.is_empty());
2828                         assert!(update_fail_htlcs.is_empty());
2829                         assert_eq!(update_fulfill_htlcs.len(), 1);
2830                         assert!(update_fail_malformed_htlcs.is_empty());
2831                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2832                 },
2833                 _ => panic!("Unexpected event"),
2834         };
2835         macro_rules! check_tx_local_broadcast {
2836                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2837                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2838                         assert_eq!(node_txn.len(), 5);
2839                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2840                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2841                         check_spends!(node_txn[0], $commitment_tx);
2842                         check_spends!(node_txn[1], $commitment_tx);
2843                         assert_ne!(node_txn[0].lock_time, 0);
2844                         assert_ne!(node_txn[1].lock_time, 0);
2845                         if $htlc_offered {
2846                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2847                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2848                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2849                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2850                         } else {
2851                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2852                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2853                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2854                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2855                         }
2856                         check_spends!(node_txn[2], $chan_tx);
2857                         check_spends!(node_txn[3], node_txn[2]);
2858                         check_spends!(node_txn[4], node_txn[2]);
2859                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2860                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2861                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2862                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2863                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2864                         assert_ne!(node_txn[3].lock_time, 0);
2865                         assert_ne!(node_txn[4].lock_time, 0);
2866                         node_txn.clear();
2867                 } }
2868         }
2869         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2870         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2871         // timeout-claim of the output that nodes[2] just claimed via success.
2872         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2873
2874         // Broadcast legit commitment tx from A on B's chain
2875         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2876         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2877         check_spends!(commitment_tx[0], chan_1.3);
2878         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2879         check_closed_broadcast!(nodes[1], false);
2880         check_added_monitors!(nodes[1], 1);
2881         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2882         assert_eq!(node_txn.len(), 4);
2883         check_spends!(node_txn[0], commitment_tx[0]);
2884         assert_eq!(node_txn[0].input.len(), 2);
2885         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2886         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2887         assert_eq!(node_txn[0].lock_time, 0);
2888         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2889         check_spends!(node_txn[1], chan_1.3);
2890         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2891         check_spends!(node_txn[2], node_txn[1]);
2892         check_spends!(node_txn[3], node_txn[1]);
2893         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2894         // we already checked the same situation with A.
2895
2896         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2897         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2898         check_closed_broadcast!(nodes[0], false);
2899         check_added_monitors!(nodes[0], 1);
2900         let events = nodes[0].node.get_and_clear_pending_events();
2901         assert_eq!(events.len(), 2);
2902         let mut first_claimed = false;
2903         for event in events {
2904                 match event {
2905                         Event::PaymentSent { payment_preimage } => {
2906                                 if payment_preimage == our_payment_preimage {
2907                                         assert!(!first_claimed);
2908                                         first_claimed = true;
2909                                 } else {
2910                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2911                                 }
2912                         },
2913                         _ => panic!("Unexpected event"),
2914                 }
2915         }
2916         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2917 }
2918
2919 #[test]
2920 fn test_htlc_on_chain_timeout() {
2921         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2922         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2923         // broadcasting the right event to other nodes in payment path.
2924         // A ------------------> B ----------------------> C (timeout)
2925         //    B's commitment tx                 C's commitment tx
2926         //            \                                  \
2927         //         B's HTLC timeout tx               B's timeout tx
2928
2929         let chanmon_cfgs = create_chanmon_cfgs(3);
2930         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2931         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2932         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2933
2934         // Create some intial channels
2935         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
2936         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
2937
2938         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2939         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2940         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2941
2942         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2943         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2944
2945         // Broadcast legit commitment tx from C on B's chain
2946         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2947         check_spends!(commitment_tx[0], chan_2.3);
2948         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2949         check_added_monitors!(nodes[2], 0);
2950         expect_pending_htlcs_forwardable!(nodes[2]);
2951         check_added_monitors!(nodes[2], 1);
2952
2953         let events = nodes[2].node.get_and_clear_pending_msg_events();
2954         assert_eq!(events.len(), 1);
2955         match events[0] {
2956                 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, .. } } => {
2957                         assert!(update_add_htlcs.is_empty());
2958                         assert!(!update_fail_htlcs.is_empty());
2959                         assert!(update_fulfill_htlcs.is_empty());
2960                         assert!(update_fail_malformed_htlcs.is_empty());
2961                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2962                 },
2963                 _ => panic!("Unexpected event"),
2964         };
2965         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2966         check_closed_broadcast!(nodes[2], false);
2967         check_added_monitors!(nodes[2], 1);
2968         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2969         assert_eq!(node_txn.len(), 1);
2970         check_spends!(node_txn[0], chan_2.3);
2971         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2972
2973         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2974         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2975         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2976         let timeout_tx;
2977         {
2978                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2979                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2980                 assert_eq!(node_txn[1], node_txn[3]);
2981                 assert_eq!(node_txn[2], node_txn[4]);
2982
2983                 check_spends!(node_txn[0], commitment_tx[0]);
2984                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2985
2986                 check_spends!(node_txn[1], chan_2.3);
2987                 check_spends!(node_txn[2], node_txn[1]);
2988                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2989                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2990
2991                 timeout_tx = node_txn[0].clone();
2992                 node_txn.clear();
2993         }
2994
2995         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2996         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2997         check_added_monitors!(nodes[1], 1);
2998         check_closed_broadcast!(nodes[1], false);
2999
3000         expect_pending_htlcs_forwardable!(nodes[1]);
3001         check_added_monitors!(nodes[1], 1);
3002         let events = nodes[1].node.get_and_clear_pending_msg_events();
3003         assert_eq!(events.len(), 1);
3004         match events[0] {
3005                 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, .. } } => {
3006                         assert!(update_add_htlcs.is_empty());
3007                         assert!(!update_fail_htlcs.is_empty());
3008                         assert!(update_fulfill_htlcs.is_empty());
3009                         assert!(update_fail_malformed_htlcs.is_empty());
3010                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3011                 },
3012                 _ => panic!("Unexpected event"),
3013         };
3014         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
3015         assert_eq!(node_txn.len(), 0);
3016
3017         // Broadcast legit commitment tx from B on A's chain
3018         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
3019         check_spends!(commitment_tx[0], chan_1.3);
3020
3021         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
3022         check_closed_broadcast!(nodes[0], false);
3023         check_added_monitors!(nodes[0], 1);
3024         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
3025         assert_eq!(node_txn.len(), 3);
3026         check_spends!(node_txn[0], commitment_tx[0]);
3027         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3028         check_spends!(node_txn[1], chan_1.3);
3029         check_spends!(node_txn[2], node_txn[1]);
3030         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
3031         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3032 }
3033
3034 #[test]
3035 fn test_simple_commitment_revoked_fail_backward() {
3036         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
3037         // and fail backward accordingly.
3038
3039         let chanmon_cfgs = create_chanmon_cfgs(3);
3040         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3041         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3042         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3043
3044         // Create some initial channels
3045         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3046         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3047
3048         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3049         // Get the will-be-revoked local txn from nodes[2]
3050         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3051         // Revoke the old state
3052         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
3053
3054         let (_, payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
3055
3056         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3057         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3058         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3059         check_added_monitors!(nodes[1], 1);
3060         check_closed_broadcast!(nodes[1], false);
3061
3062         expect_pending_htlcs_forwardable!(nodes[1]);
3063         check_added_monitors!(nodes[1], 1);
3064         let events = nodes[1].node.get_and_clear_pending_msg_events();
3065         assert_eq!(events.len(), 1);
3066         match events[0] {
3067                 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, .. } } => {
3068                         assert!(update_add_htlcs.is_empty());
3069                         assert_eq!(update_fail_htlcs.len(), 1);
3070                         assert!(update_fulfill_htlcs.is_empty());
3071                         assert!(update_fail_malformed_htlcs.is_empty());
3072                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3073
3074                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3075                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3076
3077                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3078                         assert_eq!(events.len(), 1);
3079                         match events[0] {
3080                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3081                                 _ => panic!("Unexpected event"),
3082                         }
3083                         expect_payment_failed!(nodes[0], payment_hash, false);
3084                 },
3085                 _ => panic!("Unexpected event"),
3086         }
3087 }
3088
3089 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
3090         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
3091         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
3092         // commitment transaction anymore.
3093         // To do this, we have the peer which will broadcast a revoked commitment transaction send
3094         // a number of update_fail/commitment_signed updates without ever sending the RAA in
3095         // response to our commitment_signed. This is somewhat misbehavior-y, though not
3096         // technically disallowed and we should probably handle it reasonably.
3097         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
3098         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
3099         // transactions:
3100         // * Once we move it out of our holding cell/add it, we will immediately include it in a
3101         //   commitment_signed (implying it will be in the latest remote commitment transaction).
3102         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
3103         //   and once they revoke the previous commitment transaction (allowing us to send a new
3104         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
3105         let chanmon_cfgs = create_chanmon_cfgs(3);
3106         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3107         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3108         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3109
3110         // Create some initial channels
3111         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3112         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3113
3114         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
3115         // Get the will-be-revoked local txn from nodes[2]
3116         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
3117         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
3118         // Revoke the old state
3119         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
3120
3121         let value = if use_dust {
3122                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
3123                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
3124                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
3125         } else { 3000000 };
3126
3127         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3128         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3129         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
3130
3131         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
3132         expect_pending_htlcs_forwardable!(nodes[2]);
3133         check_added_monitors!(nodes[2], 1);
3134         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3135         assert!(updates.update_add_htlcs.is_empty());
3136         assert!(updates.update_fulfill_htlcs.is_empty());
3137         assert!(updates.update_fail_malformed_htlcs.is_empty());
3138         assert_eq!(updates.update_fail_htlcs.len(), 1);
3139         assert!(updates.update_fee.is_none());
3140         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3141         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
3142         // Drop the last RAA from 3 -> 2
3143
3144         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
3145         expect_pending_htlcs_forwardable!(nodes[2]);
3146         check_added_monitors!(nodes[2], 1);
3147         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3148         assert!(updates.update_add_htlcs.is_empty());
3149         assert!(updates.update_fulfill_htlcs.is_empty());
3150         assert!(updates.update_fail_malformed_htlcs.is_empty());
3151         assert_eq!(updates.update_fail_htlcs.len(), 1);
3152         assert!(updates.update_fee.is_none());
3153         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3154         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3155         check_added_monitors!(nodes[1], 1);
3156         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
3157         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3158         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3159         check_added_monitors!(nodes[2], 1);
3160
3161         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
3162         expect_pending_htlcs_forwardable!(nodes[2]);
3163         check_added_monitors!(nodes[2], 1);
3164         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3165         assert!(updates.update_add_htlcs.is_empty());
3166         assert!(updates.update_fulfill_htlcs.is_empty());
3167         assert!(updates.update_fail_malformed_htlcs.is_empty());
3168         assert_eq!(updates.update_fail_htlcs.len(), 1);
3169         assert!(updates.update_fee.is_none());
3170         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
3171         // At this point first_payment_hash has dropped out of the latest two commitment
3172         // transactions that nodes[1] is tracking...
3173         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
3174         check_added_monitors!(nodes[1], 1);
3175         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
3176         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
3177         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
3178         check_added_monitors!(nodes[2], 1);
3179
3180         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
3181         // on nodes[2]'s RAA.
3182         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3183         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3184         let logger = test_utils::TestLogger::new();
3185         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();
3186         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
3187         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3188         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3189         check_added_monitors!(nodes[1], 0);
3190
3191         if deliver_bs_raa {
3192                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
3193                 // One monitor for the new revocation preimage, no second on as we won't generate a new
3194                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
3195                 check_added_monitors!(nodes[1], 1);
3196                 let events = nodes[1].node.get_and_clear_pending_events();
3197                 assert_eq!(events.len(), 1);
3198                 match events[0] {
3199                         Event::PendingHTLCsForwardable { .. } => { },
3200                         _ => panic!("Unexpected event"),
3201                 };
3202                 // Deliberately don't process the pending fail-back so they all fail back at once after
3203                 // block connection just like the !deliver_bs_raa case
3204         }
3205
3206         let mut failed_htlcs = HashSet::new();
3207         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
3208
3209         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3210         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3211         check_added_monitors!(nodes[1], 1);
3212         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
3213
3214         let events = nodes[1].node.get_and_clear_pending_events();
3215         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
3216         match events[0] {
3217                 Event::PaymentFailed { ref payment_hash, .. } => {
3218                         assert_eq!(*payment_hash, fourth_payment_hash);
3219                 },
3220                 _ => panic!("Unexpected event"),
3221         }
3222         if !deliver_bs_raa {
3223                 match events[1] {
3224                         Event::PendingHTLCsForwardable { .. } => { },
3225                         _ => panic!("Unexpected event"),
3226                 };
3227         }
3228         nodes[1].node.process_pending_htlc_forwards();
3229         check_added_monitors!(nodes[1], 1);
3230
3231         let events = nodes[1].node.get_and_clear_pending_msg_events();
3232         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
3233         match events[if deliver_bs_raa { 1 } else { 0 }] {
3234                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
3235                 _ => panic!("Unexpected event"),
3236         }
3237         if deliver_bs_raa {
3238                 match events[0] {
3239                         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, .. } } => {
3240                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
3241                                 assert_eq!(update_add_htlcs.len(), 1);
3242                                 assert!(update_fulfill_htlcs.is_empty());
3243                                 assert!(update_fail_htlcs.is_empty());
3244                                 assert!(update_fail_malformed_htlcs.is_empty());
3245                         },
3246                         _ => panic!("Unexpected event"),
3247                 }
3248         }
3249         match events[if deliver_bs_raa { 2 } else { 1 }] {
3250                 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, .. } } => {
3251                         assert!(update_add_htlcs.is_empty());
3252                         assert_eq!(update_fail_htlcs.len(), 3);
3253                         assert!(update_fulfill_htlcs.is_empty());
3254                         assert!(update_fail_malformed_htlcs.is_empty());
3255                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3256
3257                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
3258                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
3259                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
3260
3261                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
3262
3263                         let events = nodes[0].node.get_and_clear_pending_msg_events();
3264                         // If we delivered B's RAA we got an unknown preimage error, not something
3265                         // that we should update our routing table for.
3266                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
3267                         for event in events {
3268                                 match event {
3269                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
3270                                         _ => panic!("Unexpected event"),
3271                                 }
3272                         }
3273                         let events = nodes[0].node.get_and_clear_pending_events();
3274                         assert_eq!(events.len(), 3);
3275                         match events[0] {
3276                                 Event::PaymentFailed { ref payment_hash, .. } => {
3277                                         assert!(failed_htlcs.insert(payment_hash.0));
3278                                 },
3279                                 _ => panic!("Unexpected event"),
3280                         }
3281                         match events[1] {
3282                                 Event::PaymentFailed { ref payment_hash, .. } => {
3283                                         assert!(failed_htlcs.insert(payment_hash.0));
3284                                 },
3285                                 _ => panic!("Unexpected event"),
3286                         }
3287                         match events[2] {
3288                                 Event::PaymentFailed { ref payment_hash, .. } => {
3289                                         assert!(failed_htlcs.insert(payment_hash.0));
3290                                 },
3291                                 _ => panic!("Unexpected event"),
3292                         }
3293                 },
3294                 _ => panic!("Unexpected event"),
3295         }
3296
3297         assert!(failed_htlcs.contains(&first_payment_hash.0));
3298         assert!(failed_htlcs.contains(&second_payment_hash.0));
3299         assert!(failed_htlcs.contains(&third_payment_hash.0));
3300 }
3301
3302 #[test]
3303 fn test_commitment_revoked_fail_backward_exhaustive_a() {
3304         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
3305         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
3306         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
3307         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
3308 }
3309
3310 #[test]
3311 fn test_commitment_revoked_fail_backward_exhaustive_b() {
3312         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
3313         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
3314         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
3315         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
3316 }
3317
3318 #[test]
3319 fn fail_backward_pending_htlc_upon_channel_failure() {
3320         let chanmon_cfgs = create_chanmon_cfgs(2);
3321         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3322         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3323         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3324         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::known(), InitFeatures::known());
3325         let logger = test_utils::TestLogger::new();
3326
3327         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3328         {
3329                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3330                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3331                 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();
3332                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
3333                 check_added_monitors!(nodes[0], 1);
3334
3335                 let payment_event = {
3336                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3337                         assert_eq!(events.len(), 1);
3338                         SendEvent::from_event(events.remove(0))
3339                 };
3340                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3341                 assert_eq!(payment_event.msgs.len(), 1);
3342         }
3343
3344         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3345         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3346         {
3347                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3348                 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();
3349                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3350                 check_added_monitors!(nodes[0], 0);
3351
3352                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3353         }
3354
3355         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3356         {
3357                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3358
3359                 let secp_ctx = Secp256k1::new();
3360                 let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
3361                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3362                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
3363                 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();
3364                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3365                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3366                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3367
3368                 // Send a 0-msat update_add_htlc to fail the channel.
3369                 let update_add_htlc = msgs::UpdateAddHTLC {
3370                         channel_id: chan.2,
3371                         htlc_id: 0,
3372                         amount_msat: 0,
3373                         payment_hash,
3374                         cltv_expiry,
3375                         onion_routing_packet,
3376                 };
3377                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3378         }
3379
3380         // Check that Alice fails backward the pending HTLC from the second payment.
3381         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3382         check_closed_broadcast!(nodes[0], true);
3383         check_added_monitors!(nodes[0], 1);
3384 }
3385
3386 #[test]
3387 fn test_htlc_ignore_latest_remote_commitment() {
3388         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3389         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3390         let chanmon_cfgs = create_chanmon_cfgs(2);
3391         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3392         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3393         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3394         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3395
3396         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3397         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3398         check_closed_broadcast!(nodes[0], false);
3399         check_added_monitors!(nodes[0], 1);
3400
3401         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3402         assert_eq!(node_txn.len(), 2);
3403
3404         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3405         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3406         check_closed_broadcast!(nodes[1], false);
3407         check_added_monitors!(nodes[1], 1);
3408
3409         // Duplicate the block_connected call since this may happen due to other listeners
3410         // registering new transactions
3411         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3412 }
3413
3414 #[test]
3415 fn test_force_close_fail_back() {
3416         // Check which HTLCs are failed-backwards on channel force-closure
3417         let chanmon_cfgs = create_chanmon_cfgs(3);
3418         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3419         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3420         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3421         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3422         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3423         let logger = test_utils::TestLogger::new();
3424
3425         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3426
3427         let mut payment_event = {
3428                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3429                 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();
3430                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3431                 check_added_monitors!(nodes[0], 1);
3432
3433                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3434                 assert_eq!(events.len(), 1);
3435                 SendEvent::from_event(events.remove(0))
3436         };
3437
3438         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3439         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3440
3441         expect_pending_htlcs_forwardable!(nodes[1]);
3442
3443         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3444         assert_eq!(events_2.len(), 1);
3445         payment_event = SendEvent::from_event(events_2.remove(0));
3446         assert_eq!(payment_event.msgs.len(), 1);
3447
3448         check_added_monitors!(nodes[1], 1);
3449         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3450         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3451         check_added_monitors!(nodes[2], 1);
3452         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3453
3454         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3455         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3456         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3457
3458         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3459         check_closed_broadcast!(nodes[2], false);
3460         check_added_monitors!(nodes[2], 1);
3461         let tx = {
3462                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3463                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3464                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3465                 // back to nodes[1] upon timeout otherwise.
3466                 assert_eq!(node_txn.len(), 1);
3467                 node_txn.remove(0)
3468         };
3469
3470         let block = Block {
3471                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
3472                 txdata: vec![tx.clone()],
3473         };
3474         nodes[1].block_notifier.block_connected(&block, 1);
3475
3476         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3477         check_closed_broadcast!(nodes[1], false);
3478         check_added_monitors!(nodes[1], 1);
3479
3480         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3481         {
3482                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3483                 monitors.get_mut(&OutPoint{ txid: Txid::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), index: 0 }).unwrap()
3484                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3485         }
3486         nodes[2].block_notifier.block_connected(&block, 1);
3487         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3488         assert_eq!(node_txn.len(), 1);
3489         assert_eq!(node_txn[0].input.len(), 1);
3490         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3491         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3492         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3493
3494         check_spends!(node_txn[0], tx);
3495 }
3496
3497 #[test]
3498 fn test_unconf_chan() {
3499         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3500         let chanmon_cfgs = create_chanmon_cfgs(2);
3501         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3502         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3503         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3504         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3505
3506         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3507         assert_eq!(channel_state.by_id.len(), 1);
3508         assert_eq!(channel_state.short_to_id.len(), 1);
3509         mem::drop(channel_state);
3510
3511         let mut headers = Vec::new();
3512         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3513         headers.push(header.clone());
3514         for _i in 2..100 {
3515                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3516                 headers.push(header.clone());
3517         }
3518         let mut height = 99;
3519         while !headers.is_empty() {
3520                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3521                 height -= 1;
3522         }
3523         check_closed_broadcast!(nodes[0], false);
3524         check_added_monitors!(nodes[0], 1);
3525         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3526         assert_eq!(channel_state.by_id.len(), 0);
3527         assert_eq!(channel_state.short_to_id.len(), 0);
3528 }
3529
3530 #[test]
3531 fn test_simple_peer_disconnect() {
3532         // Test that we can reconnect when there are no lost messages
3533         let chanmon_cfgs = create_chanmon_cfgs(3);
3534         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3535         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3536         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3537         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3538         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
3539
3540         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3541         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3542         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3543
3544         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3545         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3546         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3547         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3548
3549         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3550         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3551         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3552
3553         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3554         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3555         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3556         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3557
3558         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3559         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3560
3561         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3562         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3563
3564         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3565         {
3566                 let events = nodes[0].node.get_and_clear_pending_events();
3567                 assert_eq!(events.len(), 2);
3568                 match events[0] {
3569                         Event::PaymentSent { payment_preimage } => {
3570                                 assert_eq!(payment_preimage, payment_preimage_3);
3571                         },
3572                         _ => panic!("Unexpected event"),
3573                 }
3574                 match events[1] {
3575                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3576                                 assert_eq!(payment_hash, payment_hash_5);
3577                                 assert!(rejected_by_dest);
3578                         },
3579                         _ => panic!("Unexpected event"),
3580                 }
3581         }
3582
3583         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3584         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3585 }
3586
3587 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3588         // Test that we can reconnect when in-flight HTLC updates get dropped
3589         let chanmon_cfgs = create_chanmon_cfgs(2);
3590         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3591         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3592         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3593         if messages_delivered == 0 {
3594                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3595                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3596         } else {
3597                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3598         }
3599
3600         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3601
3602         let logger = test_utils::TestLogger::new();
3603         let payment_event = {
3604                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3605                 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();
3606                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3607                 check_added_monitors!(nodes[0], 1);
3608
3609                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3610                 assert_eq!(events.len(), 1);
3611                 SendEvent::from_event(events.remove(0))
3612         };
3613         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3614
3615         if messages_delivered < 2 {
3616                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3617         } else {
3618                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3619                 if messages_delivered >= 3 {
3620                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3621                         check_added_monitors!(nodes[1], 1);
3622                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3623
3624                         if messages_delivered >= 4 {
3625                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3626                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3627                                 check_added_monitors!(nodes[0], 1);
3628
3629                                 if messages_delivered >= 5 {
3630                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3631                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3632                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3633                                         check_added_monitors!(nodes[0], 1);
3634
3635                                         if messages_delivered >= 6 {
3636                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3637                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3638                                                 check_added_monitors!(nodes[1], 1);
3639                                         }
3640                                 }
3641                         }
3642                 }
3643         }
3644
3645         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3646         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3647         if messages_delivered < 3 {
3648                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3649                 // received on either side, both sides will need to resend them.
3650                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3651         } else if messages_delivered == 3 {
3652                 // nodes[0] still wants its RAA + commitment_signed
3653                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3654         } else if messages_delivered == 4 {
3655                 // nodes[0] still wants its commitment_signed
3656                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3657         } else if messages_delivered == 5 {
3658                 // nodes[1] still wants its final RAA
3659                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3660         } else if messages_delivered == 6 {
3661                 // Everything was delivered...
3662                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3663         }
3664
3665         let events_1 = nodes[1].node.get_and_clear_pending_events();
3666         assert_eq!(events_1.len(), 1);
3667         match events_1[0] {
3668                 Event::PendingHTLCsForwardable { .. } => { },
3669                 _ => panic!("Unexpected event"),
3670         };
3671
3672         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3673         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3674         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3675
3676         nodes[1].node.process_pending_htlc_forwards();
3677
3678         let events_2 = nodes[1].node.get_and_clear_pending_events();
3679         assert_eq!(events_2.len(), 1);
3680         match events_2[0] {
3681                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3682                         assert_eq!(payment_hash_1, *payment_hash);
3683                         assert_eq!(*payment_secret, None);
3684                         assert_eq!(amt, 1000000);
3685                 },
3686                 _ => panic!("Unexpected event"),
3687         }
3688
3689         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3690         check_added_monitors!(nodes[1], 1);
3691
3692         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3693         assert_eq!(events_3.len(), 1);
3694         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3695                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3696                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3697                         assert!(updates.update_add_htlcs.is_empty());
3698                         assert!(updates.update_fail_htlcs.is_empty());
3699                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3700                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3701                         assert!(updates.update_fee.is_none());
3702                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3703                 },
3704                 _ => panic!("Unexpected event"),
3705         };
3706
3707         if messages_delivered >= 1 {
3708                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3709
3710                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3711                 assert_eq!(events_4.len(), 1);
3712                 match events_4[0] {
3713                         Event::PaymentSent { ref payment_preimage } => {
3714                                 assert_eq!(payment_preimage_1, *payment_preimage);
3715                         },
3716                         _ => panic!("Unexpected event"),
3717                 }
3718
3719                 if messages_delivered >= 2 {
3720                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3721                         check_added_monitors!(nodes[0], 1);
3722                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3723
3724                         if messages_delivered >= 3 {
3725                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3726                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3727                                 check_added_monitors!(nodes[1], 1);
3728
3729                                 if messages_delivered >= 4 {
3730                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3731                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3732                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3733                                         check_added_monitors!(nodes[1], 1);
3734
3735                                         if messages_delivered >= 5 {
3736                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3737                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3738                                                 check_added_monitors!(nodes[0], 1);
3739                                         }
3740                                 }
3741                         }
3742                 }
3743         }
3744
3745         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3746         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3747         if messages_delivered < 2 {
3748                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3749                 //TODO: Deduplicate PaymentSent events, then enable this if:
3750                 //if messages_delivered < 1 {
3751                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3752                         assert_eq!(events_4.len(), 1);
3753                         match events_4[0] {
3754                                 Event::PaymentSent { ref payment_preimage } => {
3755                                         assert_eq!(payment_preimage_1, *payment_preimage);
3756                                 },
3757                                 _ => panic!("Unexpected event"),
3758                         }
3759                 //}
3760         } else if messages_delivered == 2 {
3761                 // nodes[0] still wants its RAA + commitment_signed
3762                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3763         } else if messages_delivered == 3 {
3764                 // nodes[0] still wants its commitment_signed
3765                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3766         } else if messages_delivered == 4 {
3767                 // nodes[1] still wants its final RAA
3768                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3769         } else if messages_delivered == 5 {
3770                 // Everything was delivered...
3771                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3772         }
3773
3774         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3775         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3776         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3777
3778         // Channel should still work fine...
3779         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3780         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();
3781         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3782         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3783 }
3784
3785 #[test]
3786 fn test_drop_messages_peer_disconnect_a() {
3787         do_test_drop_messages_peer_disconnect(0);
3788         do_test_drop_messages_peer_disconnect(1);
3789         do_test_drop_messages_peer_disconnect(2);
3790         do_test_drop_messages_peer_disconnect(3);
3791 }
3792
3793 #[test]
3794 fn test_drop_messages_peer_disconnect_b() {
3795         do_test_drop_messages_peer_disconnect(4);
3796         do_test_drop_messages_peer_disconnect(5);
3797         do_test_drop_messages_peer_disconnect(6);
3798 }
3799
3800 #[test]
3801 fn test_funding_peer_disconnect() {
3802         // Test that we can lock in our funding tx while disconnected
3803         let chanmon_cfgs = create_chanmon_cfgs(2);
3804         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3805         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3806         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3807         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
3808
3809         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3810         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3811
3812         confirm_transaction(&nodes[0].block_notifier, &tx);
3813         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3814         assert_eq!(events_1.len(), 1);
3815         match events_1[0] {
3816                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3817                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3818                 },
3819                 _ => panic!("Unexpected event"),
3820         }
3821
3822         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3823
3824         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3825         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3826
3827         confirm_transaction(&nodes[1].block_notifier, &tx);
3828         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3829         assert_eq!(events_2.len(), 2);
3830         let funding_locked = match events_2[0] {
3831                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3832                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3833                         msg.clone()
3834                 },
3835                 _ => panic!("Unexpected event"),
3836         };
3837         let bs_announcement_sigs = match events_2[1] {
3838                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3839                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3840                         msg.clone()
3841                 },
3842                 _ => panic!("Unexpected event"),
3843         };
3844
3845         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3846
3847         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3848         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3849         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3850         assert_eq!(events_3.len(), 2);
3851         let as_announcement_sigs = match events_3[0] {
3852                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3853                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3854                         msg.clone()
3855                 },
3856                 _ => panic!("Unexpected event"),
3857         };
3858         let (as_announcement, as_update) = match events_3[1] {
3859                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3860                         (msg.clone(), update_msg.clone())
3861                 },
3862                 _ => panic!("Unexpected event"),
3863         };
3864
3865         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3866         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3867         assert_eq!(events_4.len(), 1);
3868         let (_, bs_update) = match events_4[0] {
3869                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3870                         (msg.clone(), update_msg.clone())
3871                 },
3872                 _ => panic!("Unexpected event"),
3873         };
3874
3875         nodes[0].net_graph_msg_handler.handle_channel_announcement(&as_announcement).unwrap();
3876         nodes[0].net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
3877         nodes[0].net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
3878
3879         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3880         let logger = test_utils::TestLogger::new();
3881         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();
3882         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3883         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3884 }
3885
3886 #[test]
3887 fn test_drop_messages_peer_disconnect_dual_htlc() {
3888         // Test that we can handle reconnecting when both sides of a channel have pending
3889         // commitment_updates when we disconnect.
3890         let chanmon_cfgs = create_chanmon_cfgs(2);
3891         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3892         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3893         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3894         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
3895         let logger = test_utils::TestLogger::new();
3896
3897         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3898
3899         // Now try to send a second payment which will fail to send
3900         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3901         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
3902         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();
3903         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3904         check_added_monitors!(nodes[0], 1);
3905
3906         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3907         assert_eq!(events_1.len(), 1);
3908         match events_1[0] {
3909                 MessageSendEvent::UpdateHTLCs { .. } => {},
3910                 _ => panic!("Unexpected event"),
3911         }
3912
3913         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3914         check_added_monitors!(nodes[1], 1);
3915
3916         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3917         assert_eq!(events_2.len(), 1);
3918         match events_2[0] {
3919                 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 } } => {
3920                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3921                         assert!(update_add_htlcs.is_empty());
3922                         assert_eq!(update_fulfill_htlcs.len(), 1);
3923                         assert!(update_fail_htlcs.is_empty());
3924                         assert!(update_fail_malformed_htlcs.is_empty());
3925                         assert!(update_fee.is_none());
3926
3927                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3928                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3929                         assert_eq!(events_3.len(), 1);
3930                         match events_3[0] {
3931                                 Event::PaymentSent { ref payment_preimage } => {
3932                                         assert_eq!(*payment_preimage, payment_preimage_1);
3933                                 },
3934                                 _ => panic!("Unexpected event"),
3935                         }
3936
3937                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3938                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3939                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3940                         check_added_monitors!(nodes[0], 1);
3941                 },
3942                 _ => panic!("Unexpected event"),
3943         }
3944
3945         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3946         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3947
3948         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3949         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3950         assert_eq!(reestablish_1.len(), 1);
3951         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3952         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3953         assert_eq!(reestablish_2.len(), 1);
3954
3955         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3956         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3957         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3958         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3959
3960         assert!(as_resp.0.is_none());
3961         assert!(bs_resp.0.is_none());
3962
3963         assert!(bs_resp.1.is_none());
3964         assert!(bs_resp.2.is_none());
3965
3966         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3967
3968         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3969         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3970         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3971         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3972         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3973         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3974         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3975         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3976         // No commitment_signed so get_event_msg's assert(len == 1) passes
3977         check_added_monitors!(nodes[1], 1);
3978
3979         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3980         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3981         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3982         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3983         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3984         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3985         assert!(bs_second_commitment_signed.update_fee.is_none());
3986         check_added_monitors!(nodes[1], 1);
3987
3988         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3989         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3990         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3991         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3992         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3993         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3994         assert!(as_commitment_signed.update_fee.is_none());
3995         check_added_monitors!(nodes[0], 1);
3996
3997         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3998         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3999         // No commitment_signed so get_event_msg's assert(len == 1) passes
4000         check_added_monitors!(nodes[0], 1);
4001
4002         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
4003         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4004         // No commitment_signed so get_event_msg's assert(len == 1) passes
4005         check_added_monitors!(nodes[1], 1);
4006
4007         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
4008         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4009         check_added_monitors!(nodes[1], 1);
4010
4011         expect_pending_htlcs_forwardable!(nodes[1]);
4012
4013         let events_5 = nodes[1].node.get_and_clear_pending_events();
4014         assert_eq!(events_5.len(), 1);
4015         match events_5[0] {
4016                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
4017                         assert_eq!(payment_hash_2, *payment_hash);
4018                         assert_eq!(*payment_secret, None);
4019                 },
4020                 _ => panic!("Unexpected event"),
4021         }
4022
4023         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
4024         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4025         check_added_monitors!(nodes[0], 1);
4026
4027         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
4028 }
4029
4030 fn do_test_htlc_timeout(send_partial_mpp: bool) {
4031         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
4032         // to avoid our counterparty failing the channel.
4033         let chanmon_cfgs = create_chanmon_cfgs(2);
4034         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4035         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4036         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4037
4038         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4039         let logger = test_utils::TestLogger::new();
4040
4041         let our_payment_hash = if send_partial_mpp {
4042                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4043                 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();
4044                 let (_, our_payment_hash) = get_payment_preimage_hash!(&nodes[0]);
4045                 let payment_secret = PaymentSecret([0xdb; 32]);
4046                 // Use the utility function send_payment_along_path to send the payment with MPP data which
4047                 // indicates there are more HTLCs coming.
4048                 nodes[0].node.send_payment_along_path(&route.paths[0], &our_payment_hash, &Some(payment_secret), 200000, CHAN_CONFIRM_DEPTH).unwrap();
4049                 check_added_monitors!(nodes[0], 1);
4050                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4051                 assert_eq!(events.len(), 1);
4052                 // Now do the relevant commitment_signed/RAA dances along the path, noting that the final
4053                 // hop should *not* yet generate any PaymentReceived event(s).
4054                 pass_along_path(&nodes[0], &[&nodes[1]], 100000, our_payment_hash, Some(payment_secret), events.drain(..).next().unwrap(), false);
4055                 our_payment_hash
4056         } else {
4057                 route_payment(&nodes[0], &[&nodes[1]], 100000).1
4058         };
4059
4060         let mut block = Block {
4061                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4062                 txdata: vec![],
4063         };
4064         nodes[0].block_notifier.block_connected(&block, 101);
4065         nodes[1].block_notifier.block_connected(&block, 101);
4066         for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4067                 block.header.prev_blockhash = block.bitcoin_hash();
4068                 nodes[0].block_notifier.block_connected(&block, i);
4069                 nodes[1].block_notifier.block_connected(&block, i);
4070         }
4071
4072         expect_pending_htlcs_forwardable!(nodes[1]);
4073
4074         check_added_monitors!(nodes[1], 1);
4075         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4076         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
4077         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
4078         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
4079         assert!(htlc_timeout_updates.update_fee.is_none());
4080
4081         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
4082         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
4083         // 100_000 msat as u64, followed by a height of 123 as u32
4084         let mut expected_failure_data = byte_utils::be64_to_array(100_000).to_vec();
4085         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(123));
4086         expect_payment_failed!(nodes[0], our_payment_hash, true, 0x4000 | 15, &expected_failure_data[..]);
4087 }
4088
4089 #[test]
4090 fn test_htlc_timeout() {
4091         do_test_htlc_timeout(true);
4092         do_test_htlc_timeout(false);
4093 }
4094
4095 fn do_test_holding_cell_htlc_add_timeouts(forwarded_htlc: bool) {
4096         // Tests that HTLCs in the holding cell are timed out after the requisite number of blocks.
4097         let chanmon_cfgs = create_chanmon_cfgs(3);
4098         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4099         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4100         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4101         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4102         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
4103         let logger = test_utils::TestLogger::new();
4104
4105         // Route a first payment to get the 1 -> 2 channel in awaiting_raa...
4106         let (_, first_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4107         {
4108                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4109                 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();
4110                 nodes[1].node.send_payment(&route, first_payment_hash, &None).unwrap();
4111         }
4112         assert_eq!(nodes[1].node.get_and_clear_pending_msg_events().len(), 1);
4113         check_added_monitors!(nodes[1], 1);
4114
4115         // Now attempt to route a second payment, which should be placed in the holding cell
4116         let (_, second_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4117         if forwarded_htlc {
4118                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
4119                 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();
4120                 nodes[0].node.send_payment(&route, second_payment_hash, &None).unwrap();
4121                 check_added_monitors!(nodes[0], 1);
4122                 let payment_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
4123                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
4124                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
4125                 expect_pending_htlcs_forwardable!(nodes[1]);
4126                 check_added_monitors!(nodes[1], 0);
4127         } else {
4128                 let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
4129                 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();
4130                 nodes[1].node.send_payment(&route, second_payment_hash, &None).unwrap();
4131                 check_added_monitors!(nodes[1], 0);
4132         }
4133
4134         let mut block = Block {
4135                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
4136                 txdata: vec![],
4137         };
4138         nodes[1].block_notifier.block_connected(&block, 101);
4139         for i in 102..TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
4140                 block.header.prev_blockhash = block.bitcoin_hash();
4141                 nodes[1].block_notifier.block_connected(&block, i);
4142         }
4143
4144         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4145         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
4146
4147         block.header.prev_blockhash = block.bitcoin_hash();
4148         nodes[1].block_notifier.block_connected(&block, TEST_FINAL_CLTV + 100 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS);
4149
4150         if forwarded_htlc {
4151                 expect_pending_htlcs_forwardable!(nodes[1]);
4152                 check_added_monitors!(nodes[1], 1);
4153                 let fail_commit = nodes[1].node.get_and_clear_pending_msg_events();
4154                 assert_eq!(fail_commit.len(), 1);
4155                 match fail_commit[0] {
4156                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fail_htlcs, ref commitment_signed, .. }, .. } => {
4157                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
4158                                 commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, true, true);
4159                         },
4160                         _ => unreachable!(),
4161                 }
4162                 expect_payment_failed!(nodes[0], second_payment_hash, false);
4163                 if let &MessageSendEvent::PaymentFailureNetworkUpdate { ref update } = &nodes[0].node.get_and_clear_pending_msg_events()[0] {
4164                         match update {
4165                                 &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {},
4166                                 _ => panic!("Unexpected event"),
4167                         }
4168                 } else {
4169                         panic!("Unexpected event");
4170                 }
4171         } else {
4172                 expect_payment_failed!(nodes[1], second_payment_hash, true);
4173         }
4174 }
4175
4176 #[test]
4177 fn test_holding_cell_htlc_add_timeouts() {
4178         do_test_holding_cell_htlc_add_timeouts(false);
4179         do_test_holding_cell_htlc_add_timeouts(true);
4180 }
4181
4182 #[test]
4183 fn test_invalid_channel_announcement() {
4184         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
4185         let secp_ctx = Secp256k1::new();
4186         let chanmon_cfgs = create_chanmon_cfgs(2);
4187         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4188         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4189         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4190
4191         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::known(), InitFeatures::known());
4192
4193         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
4194         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
4195         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4196         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
4197
4198         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 } );
4199
4200         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4201         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
4202
4203         let as_network_key = nodes[0].node.get_our_node_id();
4204         let bs_network_key = nodes[1].node.get_our_node_id();
4205
4206         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
4207
4208         let mut chan_announcement;
4209
4210         macro_rules! dummy_unsigned_msg {
4211                 () => {
4212                         msgs::UnsignedChannelAnnouncement {
4213                                 features: ChannelFeatures::known(),
4214                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
4215                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
4216                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
4217                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
4218                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
4219                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
4220                                 excess_data: Vec::new(),
4221                         };
4222                 }
4223         }
4224
4225         macro_rules! sign_msg {
4226                 ($unsigned_msg: expr) => {
4227                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
4228                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key);
4229                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key);
4230                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
4231                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
4232                         chan_announcement = msgs::ChannelAnnouncement {
4233                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
4234                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
4235                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
4236                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
4237                                 contents: $unsigned_msg
4238                         }
4239                 }
4240         }
4241
4242         let unsigned_msg = dummy_unsigned_msg!();
4243         sign_msg!(unsigned_msg);
4244         assert_eq!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).unwrap(), true);
4245         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 } );
4246
4247         // Configured with Network::Testnet
4248         let mut unsigned_msg = dummy_unsigned_msg!();
4249         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
4250         sign_msg!(unsigned_msg);
4251         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4252
4253         let mut unsigned_msg = dummy_unsigned_msg!();
4254         unsigned_msg.chain_hash = BlockHash::hash(&[1,2,3,4,5,6,7,8,9]);
4255         sign_msg!(unsigned_msg);
4256         assert!(nodes[0].net_graph_msg_handler.handle_channel_announcement(&chan_announcement).is_err());
4257 }
4258
4259 #[test]
4260 fn test_no_txn_manager_serialize_deserialize() {
4261         let chanmon_cfgs = create_chanmon_cfgs(2);
4262         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4263         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4264         let logger: test_utils::TestLogger;
4265         let fee_estimator: test_utils::TestFeeEstimator;
4266         let new_chan_monitor: test_utils::TestChannelMonitor;
4267         let keys_manager: test_utils::TestKeysInterface;
4268         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4269         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4270
4271         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::known(), InitFeatures::known());
4272
4273         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4274
4275         let nodes_0_serialized = nodes[0].node.encode();
4276         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4277         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4278
4279         logger = test_utils::TestLogger::new();
4280         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4281         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4282         nodes[0].chan_monitor = &new_chan_monitor;
4283         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4284         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4285         assert!(chan_0_monitor_read.is_empty());
4286
4287         let mut nodes_0_read = &nodes_0_serialized[..];
4288         let config = UserConfig::default();
4289         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4290         let (_, nodes_0_deserialized_tmp) = {
4291                 let mut channel_monitors = HashMap::new();
4292                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4293                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4294                         default_config: config,
4295                         keys_manager: &keys_manager,
4296                         fee_estimator: &fee_estimator,
4297                         monitor: nodes[0].chan_monitor,
4298                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4299                         logger: &logger,
4300                         channel_monitors: &mut channel_monitors,
4301                 }).unwrap()
4302         };
4303         nodes_0_deserialized = nodes_0_deserialized_tmp;
4304         assert!(nodes_0_read.is_empty());
4305
4306         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4307         nodes[0].node = &nodes_0_deserialized;
4308         nodes[0].block_notifier.register_listener(nodes[0].node);
4309         assert_eq!(nodes[0].node.list_channels().len(), 1);
4310         check_added_monitors!(nodes[0], 1);
4311
4312         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4313         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4314         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4315         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4316
4317         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4318         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4319         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4320         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4321
4322         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4323         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4324         for node in nodes.iter() {
4325                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4326                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4327                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4328         }
4329
4330         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4331 }
4332
4333 #[test]
4334 fn test_manager_serialize_deserialize_events() {
4335         // This test makes sure the events field in ChannelManager survives de/serialization
4336         let chanmon_cfgs = create_chanmon_cfgs(2);
4337         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4338         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4339         let fee_estimator: test_utils::TestFeeEstimator;
4340         let logger: test_utils::TestLogger;
4341         let new_chan_monitor: test_utils::TestChannelMonitor;
4342         let keys_manager: test_utils::TestKeysInterface;
4343         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4344         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4345
4346         // Start creating a channel, but stop right before broadcasting the event message FundingBroadcastSafe
4347         let channel_value = 100000;
4348         let push_msat = 10001;
4349         let a_flags = InitFeatures::known();
4350         let b_flags = InitFeatures::known();
4351         let node_a = nodes.pop().unwrap();
4352         let node_b = nodes.pop().unwrap();
4353         node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42, None).unwrap();
4354         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()));
4355         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()));
4356
4357         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&node_a, channel_value, 42);
4358
4359         node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
4360         check_added_monitors!(node_a, 0);
4361
4362         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()));
4363         {
4364                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
4365                 assert_eq!(added_monitors.len(), 1);
4366                 assert_eq!(added_monitors[0].0, funding_output);
4367                 added_monitors.clear();
4368         }
4369
4370         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()));
4371         {
4372                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
4373                 assert_eq!(added_monitors.len(), 1);
4374                 assert_eq!(added_monitors[0].0, funding_output);
4375                 added_monitors.clear();
4376         }
4377         // Normally, this is where node_a would check for a FundingBroadcastSafe event, but the test de/serializes first instead
4378
4379         nodes.push(node_a);
4380         nodes.push(node_b);
4381
4382         // Start the de/seriailization process mid-channel creation to check that the channel manager will hold onto events that are serialized
4383         let nodes_0_serialized = nodes[0].node.encode();
4384         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4385         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4386
4387         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4388         logger = test_utils::TestLogger::new();
4389         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4390         nodes[0].chan_monitor = &new_chan_monitor;
4391         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4392         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4393         assert!(chan_0_monitor_read.is_empty());
4394
4395         let mut nodes_0_read = &nodes_0_serialized[..];
4396         let config = UserConfig::default();
4397         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4398         let (_, nodes_0_deserialized_tmp) = {
4399                 let mut channel_monitors = HashMap::new();
4400                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4401                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4402                         default_config: config,
4403                         keys_manager: &keys_manager,
4404                         fee_estimator: &fee_estimator,
4405                         monitor: nodes[0].chan_monitor,
4406                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4407                         logger: &logger,
4408                         channel_monitors: &mut channel_monitors,
4409                 }).unwrap()
4410         };
4411         nodes_0_deserialized = nodes_0_deserialized_tmp;
4412         assert!(nodes_0_read.is_empty());
4413
4414         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4415
4416         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4417         nodes[0].node = &nodes_0_deserialized;
4418
4419         // After deserializing, make sure the FundingBroadcastSafe event is still held by the channel manager
4420         let events_4 = nodes[0].node.get_and_clear_pending_events();
4421         assert_eq!(events_4.len(), 1);
4422         match events_4[0] {
4423                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
4424                         assert_eq!(user_channel_id, 42);
4425                         assert_eq!(*funding_txo, funding_output);
4426                 },
4427                 _ => panic!("Unexpected event"),
4428         };
4429
4430         // Make sure the channel is functioning as though the de/serialization never happened
4431         nodes[0].block_notifier.register_listener(nodes[0].node);
4432         assert_eq!(nodes[0].node.list_channels().len(), 1);
4433         check_added_monitors!(nodes[0], 1);
4434
4435         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4436         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
4437         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4438         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
4439
4440         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
4441         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4442         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
4443         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4444
4445         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
4446         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
4447         for node in nodes.iter() {
4448                 assert!(node.net_graph_msg_handler.handle_channel_announcement(&announcement).unwrap());
4449                 node.net_graph_msg_handler.handle_channel_update(&as_update).unwrap();
4450                 node.net_graph_msg_handler.handle_channel_update(&bs_update).unwrap();
4451         }
4452
4453         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
4454 }
4455
4456 #[test]
4457 fn test_simple_manager_serialize_deserialize() {
4458         let chanmon_cfgs = create_chanmon_cfgs(2);
4459         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4460         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4461         let logger: test_utils::TestLogger;
4462         let fee_estimator: test_utils::TestFeeEstimator;
4463         let new_chan_monitor: test_utils::TestChannelMonitor;
4464         let keys_manager: test_utils::TestKeysInterface;
4465         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4466         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4467         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4468
4469         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4470         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
4471
4472         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4473
4474         let nodes_0_serialized = nodes[0].node.encode();
4475         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
4476         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
4477
4478         logger = test_utils::TestLogger::new();
4479         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4480         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4481         nodes[0].chan_monitor = &new_chan_monitor;
4482         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
4483         let (_, mut chan_0_monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read).unwrap();
4484         assert!(chan_0_monitor_read.is_empty());
4485
4486         let mut nodes_0_read = &nodes_0_serialized[..];
4487         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4488         let (_, nodes_0_deserialized_tmp) = {
4489                 let mut channel_monitors = HashMap::new();
4490                 channel_monitors.insert(chan_0_monitor.get_funding_txo().0, &mut chan_0_monitor);
4491                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4492                         default_config: UserConfig::default(),
4493                         keys_manager: &keys_manager,
4494                         fee_estimator: &fee_estimator,
4495                         monitor: nodes[0].chan_monitor,
4496                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4497                         logger: &logger,
4498                         channel_monitors: &mut channel_monitors,
4499                 }).unwrap()
4500         };
4501         nodes_0_deserialized = nodes_0_deserialized_tmp;
4502         assert!(nodes_0_read.is_empty());
4503
4504         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().0, chan_0_monitor).is_ok());
4505         nodes[0].node = &nodes_0_deserialized;
4506         check_added_monitors!(nodes[0], 1);
4507
4508         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4509
4510         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
4511         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
4512 }
4513
4514 #[test]
4515 fn test_manager_serialize_deserialize_inconsistent_monitor() {
4516         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
4517         let chanmon_cfgs = create_chanmon_cfgs(4);
4518         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
4519         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
4520         let logger: test_utils::TestLogger;
4521         let fee_estimator: test_utils::TestFeeEstimator;
4522         let new_chan_monitor: test_utils::TestChannelMonitor;
4523         let keys_manager: test_utils::TestKeysInterface;
4524         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>;
4525         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
4526         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4527         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::known(), InitFeatures::known());
4528         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::known(), InitFeatures::known());
4529
4530         let mut node_0_stale_monitors_serialized = Vec::new();
4531         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4532                 let mut writer = test_utils::TestVecWriter(Vec::new());
4533                 monitor.1.write_for_disk(&mut writer).unwrap();
4534                 node_0_stale_monitors_serialized.push(writer.0);
4535         }
4536
4537         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
4538
4539         // Serialize the ChannelManager here, but the monitor we keep up-to-date
4540         let nodes_0_serialized = nodes[0].node.encode();
4541
4542         route_payment(&nodes[0], &[&nodes[3]], 1000000);
4543         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4544         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4545         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
4546
4547         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
4548         // nodes[3])
4549         let mut node_0_monitors_serialized = Vec::new();
4550         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
4551                 let mut writer = test_utils::TestVecWriter(Vec::new());
4552                 monitor.1.write_for_disk(&mut writer).unwrap();
4553                 node_0_monitors_serialized.push(writer.0);
4554         }
4555
4556         logger = test_utils::TestLogger::new();
4557         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
4558         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), &logger, &fee_estimator);
4559         nodes[0].chan_monitor = &new_chan_monitor;
4560
4561         let mut node_0_stale_monitors = Vec::new();
4562         for serialized in node_0_stale_monitors_serialized.iter() {
4563                 let mut read = &serialized[..];
4564                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4565                 assert!(read.is_empty());
4566                 node_0_stale_monitors.push(monitor);
4567         }
4568
4569         let mut node_0_monitors = Vec::new();
4570         for serialized in node_0_monitors_serialized.iter() {
4571                 let mut read = &serialized[..];
4572                 let (_, monitor) = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read).unwrap();
4573                 assert!(read.is_empty());
4574                 node_0_monitors.push(monitor);
4575         }
4576
4577         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
4578
4579         let mut nodes_0_read = &nodes_0_serialized[..];
4580         if let Err(msgs::DecodeError::InvalidValue) =
4581                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4582                 default_config: UserConfig::default(),
4583                 keys_manager: &keys_manager,
4584                 fee_estimator: &fee_estimator,
4585                 monitor: nodes[0].chan_monitor,
4586                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4587                 logger: &logger,
4588                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4589         }) { } else {
4590                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
4591         };
4592
4593         let mut nodes_0_read = &nodes_0_serialized[..];
4594         let (_, nodes_0_deserialized_tmp) =
4595                 <(BlockHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator, &test_utils::TestLogger>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
4596                 default_config: UserConfig::default(),
4597                 keys_manager: &keys_manager,
4598                 fee_estimator: &fee_estimator,
4599                 monitor: nodes[0].chan_monitor,
4600                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4601                 logger: &logger,
4602                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().0, monitor) }).collect(),
4603         }).unwrap();
4604         nodes_0_deserialized = nodes_0_deserialized_tmp;
4605         assert!(nodes_0_read.is_empty());
4606
4607         { // Channel close should result in a commitment tx and an HTLC tx
4608                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4609                 assert_eq!(txn.len(), 2);
4610                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4611                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4612         }
4613
4614         for monitor in node_0_monitors.drain(..) {
4615                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().0, monitor).is_ok());
4616                 check_added_monitors!(nodes[0], 1);
4617         }
4618         nodes[0].node = &nodes_0_deserialized;
4619
4620         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4621         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4622         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4623         //... and we can even still claim the payment!
4624         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4625
4626         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4627         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4628         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4629         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4630         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4631         assert_eq!(msg_events.len(), 1);
4632         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4633                 match action {
4634                         &ErrorAction::SendErrorMessage { ref msg } => {
4635                                 assert_eq!(msg.channel_id, channel_id);
4636                         },
4637                         _ => panic!("Unexpected event!"),
4638                 }
4639         }
4640 }
4641
4642 macro_rules! check_spendable_outputs {
4643         ($node: expr, $der_idx: expr, $keysinterface: expr, $chan_value: expr) => {
4644                 {
4645                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
4646                         let mut txn = Vec::new();
4647                         for event in events {
4648                                 match event {
4649                                         Event::SpendableOutputs { ref outputs } => {
4650                                                 for outp in outputs {
4651                                                         match *outp {
4652                                                                 SpendableOutputDescriptor::StaticOutputRemotePayment { ref outpoint, ref output, ref key_derivation_params } => {
4653                                                                         let input = TxIn {
4654                                                                                 previous_output: outpoint.clone(),
4655                                                                                 script_sig: Script::new(),
4656                                                                                 sequence: 0,
4657                                                                                 witness: Vec::new(),
4658                                                                         };
4659                                                                         let outp = TxOut {
4660                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4661                                                                                 value: output.value,
4662                                                                         };
4663                                                                         let mut spend_tx = Transaction {
4664                                                                                 version: 2,
4665                                                                                 lock_time: 0,
4666                                                                                 input: vec![input],
4667                                                                                 output: vec![outp],
4668                                                                         };
4669                                                                         let secp_ctx = Secp256k1::new();
4670                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4671                                                                         let remotepubkey = keys.pubkeys().payment_point;
4672                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_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 remotesig = secp_ctx.sign(&sighash, &keys.inner.payment_key);
4675                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4676                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4677                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4678                                                                         txn.push(spend_tx);
4679                                                                 },
4680                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref per_commitment_point, ref to_self_delay, ref output, ref key_derivation_params, ref remote_revocation_pubkey } => {
4681                                                                         let input = TxIn {
4682                                                                                 previous_output: outpoint.clone(),
4683                                                                                 script_sig: Script::new(),
4684                                                                                 sequence: *to_self_delay as u32,
4685                                                                                 witness: Vec::new(),
4686                                                                         };
4687                                                                         let outp = TxOut {
4688                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4689                                                                                 value: output.value,
4690                                                                         };
4691                                                                         let mut spend_tx = Transaction {
4692                                                                                 version: 2,
4693                                                                                 lock_time: 0,
4694                                                                                 input: vec![input],
4695                                                                                 output: vec![outp],
4696                                                                         };
4697                                                                         let secp_ctx = Secp256k1::new();
4698                                                                         let keys = $keysinterface.derive_channel_keys($chan_value, key_derivation_params.0, key_derivation_params.1);
4699                                                                         if let Ok(delayed_payment_key) = chan_utils::derive_private_key(&secp_ctx, &per_commitment_point, &keys.inner.delayed_payment_base_key) {
4700
4701                                                                                 let delayed_payment_pubkey = PublicKey::from_secret_key(&secp_ctx, &delayed_payment_key);
4702                                                                                 let witness_script = chan_utils::get_revokeable_redeemscript(remote_revocation_pubkey, *to_self_delay, &delayed_payment_pubkey);
4703                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4704                                                                                 let local_delayedsig = secp_ctx.sign(&sighash, &delayed_payment_key);
4705                                                                                 spend_tx.input[0].witness.push(local_delayedsig.serialize_der().to_vec());
4706                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4707                                                                                 spend_tx.input[0].witness.push(vec!()); //MINIMALIF
4708                                                                                 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4709                                                                         } else { panic!() }
4710                                                                         txn.push(spend_tx);
4711                                                                 },
4712                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4713                                                                         let secp_ctx = Secp256k1::new();
4714                                                                         let input = TxIn {
4715                                                                                 previous_output: outpoint.clone(),
4716                                                                                 script_sig: Script::new(),
4717                                                                                 sequence: 0,
4718                                                                                 witness: Vec::new(),
4719                                                                         };
4720                                                                         let outp = TxOut {
4721                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4722                                                                                 value: output.value,
4723                                                                         };
4724                                                                         let mut spend_tx = Transaction {
4725                                                                                 version: 2,
4726                                                                                 lock_time: 0,
4727                                                                                 input: vec![input],
4728                                                                                 output: vec![outp.clone()],
4729                                                                         };
4730                                                                         let secret = {
4731                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4732                                                                                         Ok(master_key) => {
4733                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4734                                                                                                         Ok(key) => key,
4735                                                                                                         Err(_) => panic!("Your RNG is busted"),
4736                                                                                                 }
4737                                                                                         }
4738                                                                                         Err(_) => panic!("Your rng is busted"),
4739                                                                                 }
4740                                                                         };
4741                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4742                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4743                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4744                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4745                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4746                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4747                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4748                                                                         txn.push(spend_tx);
4749                                                                 },
4750                                                         }
4751                                                 }
4752                                         },
4753                                         _ => panic!("Unexpected event"),
4754                                 };
4755                         }
4756                         txn
4757                 }
4758         }
4759 }
4760
4761 #[test]
4762 fn test_claim_sizeable_push_msat() {
4763         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4764         let chanmon_cfgs = create_chanmon_cfgs(2);
4765         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4766         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4767         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4768
4769         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4770         nodes[1].node.force_close_channel(&chan.2);
4771         check_closed_broadcast!(nodes[1], false);
4772         check_added_monitors!(nodes[1], 1);
4773         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4774         assert_eq!(node_txn.len(), 1);
4775         check_spends!(node_txn[0], chan.3);
4776         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
4777
4778         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4779         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
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(), 1);
4784         check_spends!(spend_txn[0], node_txn[0]);
4785 }
4786
4787 #[test]
4788 fn test_claim_on_remote_sizeable_push_msat() {
4789         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4790         // to_remote output is encumbered by a P2WPKH
4791         let chanmon_cfgs = create_chanmon_cfgs(2);
4792         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4793         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4794         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4795
4796         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::known(), InitFeatures::known());
4797         nodes[0].node.force_close_channel(&chan.2);
4798         check_closed_broadcast!(nodes[0], false);
4799         check_added_monitors!(nodes[0], 1);
4800
4801         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4802         assert_eq!(node_txn.len(), 1);
4803         check_spends!(node_txn[0], chan.3);
4804         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
4805
4806         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4807         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4808         check_closed_broadcast!(nodes[1], false);
4809         check_added_monitors!(nodes[1], 1);
4810         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4811
4812         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4813         assert_eq!(spend_txn.len(), 2);
4814         assert_eq!(spend_txn[0], spend_txn[1]);
4815         check_spends!(spend_txn[0], node_txn[0]);
4816 }
4817
4818 #[test]
4819 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4820         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4821         // to_remote output is encumbered by a P2WPKH
4822
4823         let chanmon_cfgs = create_chanmon_cfgs(2);
4824         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4825         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4826         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4827
4828         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::known(), InitFeatures::known());
4829         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4830         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4831         assert_eq!(revoked_local_txn[0].input.len(), 1);
4832         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4833
4834         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4835         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4836         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4837         check_closed_broadcast!(nodes[1], false);
4838         check_added_monitors!(nodes[1], 1);
4839
4840         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4841         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4842         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4843         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4844
4845         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4846         assert_eq!(spend_txn.len(), 3);
4847         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4848         check_spends!(spend_txn[0], revoked_local_txn[0]);
4849         check_spends!(spend_txn[2], node_txn[0]);
4850 }
4851
4852 #[test]
4853 fn test_static_spendable_outputs_preimage_tx() {
4854         let chanmon_cfgs = create_chanmon_cfgs(2);
4855         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4856         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4857         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4858
4859         // Create some initial channels
4860         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4861
4862         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4863
4864         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4865         assert_eq!(commitment_tx[0].input.len(), 1);
4866         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4867
4868         // Settle A's commitment tx on B's chain
4869         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4870         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4871         check_added_monitors!(nodes[1], 1);
4872         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4873         check_added_monitors!(nodes[1], 1);
4874         let events = nodes[1].node.get_and_clear_pending_msg_events();
4875         match events[0] {
4876                 MessageSendEvent::UpdateHTLCs { .. } => {},
4877                 _ => panic!("Unexpected event"),
4878         }
4879         match events[1] {
4880                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4881                 _ => panic!("Unexepected event"),
4882         }
4883
4884         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4885         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4886         assert_eq!(node_txn.len(), 3);
4887         check_spends!(node_txn[0], commitment_tx[0]);
4888         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4889         check_spends!(node_txn[1], chan_1.3);
4890         check_spends!(node_txn[2], node_txn[1]);
4891
4892         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4893         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4894         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4895
4896         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4897         assert_eq!(spend_txn.len(), 1);
4898         check_spends!(spend_txn[0], node_txn[0]);
4899 }
4900
4901 #[test]
4902 fn test_static_spendable_outputs_timeout_tx() {
4903         let chanmon_cfgs = create_chanmon_cfgs(2);
4904         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4905         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4906         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4907
4908         // Create some initial channels
4909         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4910
4911         // Rebalance the network a bit by relaying one payment through all the channels ...
4912         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4913
4914         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4915
4916         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4917         assert_eq!(commitment_tx[0].input.len(), 1);
4918         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4919
4920         // Settle A's commitment tx on B' chain
4921         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4922         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4923         check_added_monitors!(nodes[1], 1);
4924         let events = nodes[1].node.get_and_clear_pending_msg_events();
4925         match events[0] {
4926                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4927                 _ => panic!("Unexpected event"),
4928         }
4929
4930         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4931         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4932         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4933         check_spends!(node_txn[0],  commitment_tx[0].clone());
4934         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4935         check_spends!(node_txn[1], chan_1.3.clone());
4936         check_spends!(node_txn[2], node_txn[1]);
4937
4938         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4939         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4940         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4941         expect_payment_failed!(nodes[1], our_payment_hash, true);
4942
4943         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4944         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4945         check_spends!(spend_txn[2], node_txn[0].clone());
4946 }
4947
4948 #[test]
4949 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4950         let chanmon_cfgs = create_chanmon_cfgs(2);
4951         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4952         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4953         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4954
4955         // Create some initial channels
4956         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4957
4958         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4959         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4960         assert_eq!(revoked_local_txn[0].input.len(), 1);
4961         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4962
4963         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4964
4965         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4966         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4967         check_closed_broadcast!(nodes[1], false);
4968         check_added_monitors!(nodes[1], 1);
4969
4970         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4971         assert_eq!(node_txn.len(), 2);
4972         assert_eq!(node_txn[0].input.len(), 2);
4973         check_spends!(node_txn[0], revoked_local_txn[0]);
4974
4975         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4976         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4977         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4978
4979         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
4980         assert_eq!(spend_txn.len(), 1);
4981         check_spends!(spend_txn[0], node_txn[0]);
4982 }
4983
4984 #[test]
4985 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4986         let chanmon_cfgs = create_chanmon_cfgs(2);
4987         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4988         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4989         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4990
4991         // Create some initial channels
4992         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
4993
4994         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4995         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4996         assert_eq!(revoked_local_txn[0].input.len(), 1);
4997         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4998
4999         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5000
5001         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5002         // A will generate HTLC-Timeout from revoked commitment tx
5003         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5004         check_closed_broadcast!(nodes[0], false);
5005         check_added_monitors!(nodes[0], 1);
5006
5007         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5008         assert_eq!(revoked_htlc_txn.len(), 2);
5009         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5010         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5011         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5012         check_spends!(revoked_htlc_txn[1], chan_1.3);
5013
5014         // B will generate justice tx from A's revoked commitment/HTLC tx
5015         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
5016         check_closed_broadcast!(nodes[1], false);
5017         check_added_monitors!(nodes[1], 1);
5018
5019         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5020         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
5021         assert_eq!(node_txn[0].input.len(), 2);
5022         check_spends!(node_txn[0], revoked_local_txn[0]);
5023         assert_eq!(node_txn[1].input.len(), 1);
5024         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5025         assert_eq!(node_txn[2].input.len(), 1);
5026         check_spends!(node_txn[2], revoked_local_txn[0]);
5027         check_spends!(node_txn[3], chan_1.3);
5028
5029         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5030         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5031         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5032
5033         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
5034         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5035         assert_eq!(spend_txn.len(), 2);
5036         check_spends!(spend_txn[0], node_txn[0]);
5037         check_spends!(spend_txn[1], node_txn[2]);
5038 }
5039
5040 #[test]
5041 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
5042         let chanmon_cfgs = create_chanmon_cfgs(2);
5043         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5044         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5045         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5046
5047         // Create some initial channels
5048         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5049
5050         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5051         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5052         assert_eq!(revoked_local_txn[0].input.len(), 1);
5053         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5054
5055         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
5056
5057         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5058         // B will generate HTLC-Success from revoked commitment tx
5059         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5060         check_closed_broadcast!(nodes[1], false);
5061         check_added_monitors!(nodes[1], 1);
5062         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5063
5064         assert_eq!(revoked_htlc_txn.len(), 2);
5065         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
5066         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5067         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
5068
5069         // A will generate justice tx from B's revoked commitment/HTLC tx
5070         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
5071         check_closed_broadcast!(nodes[0], false);
5072         check_added_monitors!(nodes[0], 1);
5073
5074         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5075         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
5076         assert_eq!(node_txn[1].input.len(), 1);
5077         check_spends!(node_txn[1], revoked_htlc_txn[0]);
5078
5079         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5080         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
5081         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
5082
5083         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
5084         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5085         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
5086         assert_eq!(spend_txn[0], spend_txn[1]);
5087         assert_eq!(spend_txn[0], spend_txn[2]);
5088         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
5089         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
5090         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
5091 }
5092
5093 #[test]
5094 fn test_onchain_to_onchain_claim() {
5095         // Test that in case of channel closure, we detect the state of output thanks to
5096         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
5097         // First, have C claim an HTLC against its own latest commitment transaction.
5098         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
5099         // channel.
5100         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
5101         // gets broadcast.
5102
5103         let chanmon_cfgs = create_chanmon_cfgs(3);
5104         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5105         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5106         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5107
5108         // Create some initial channels
5109         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5110         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5111
5112         // Rebalance the network a bit by relaying one payment through all the channels ...
5113         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5114         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
5115
5116         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
5117         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
5118         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
5119         check_spends!(commitment_tx[0], chan_2.3);
5120         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
5121         check_added_monitors!(nodes[2], 1);
5122         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5123         assert!(updates.update_add_htlcs.is_empty());
5124         assert!(updates.update_fail_htlcs.is_empty());
5125         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5126         assert!(updates.update_fail_malformed_htlcs.is_empty());
5127
5128         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5129         check_closed_broadcast!(nodes[2], false);
5130         check_added_monitors!(nodes[2], 1);
5131
5132         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
5133         assert_eq!(c_txn.len(), 3);
5134         assert_eq!(c_txn[0], c_txn[2]);
5135         assert_eq!(commitment_tx[0], c_txn[1]);
5136         check_spends!(c_txn[1], chan_2.3);
5137         check_spends!(c_txn[2], c_txn[1]);
5138         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
5139         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5140         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5141         assert_eq!(c_txn[0].lock_time, 0); // Success tx
5142
5143         // 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
5144         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
5145         {
5146                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5147                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
5148                 assert_eq!(b_txn.len(), 3);
5149                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
5150                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
5151                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5152                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
5153                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5154                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
5155                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5156                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5157                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
5158                 b_txn.clear();
5159         }
5160         check_added_monitors!(nodes[1], 1);
5161         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5162         check_added_monitors!(nodes[1], 1);
5163         match msg_events[0] {
5164                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
5165                 _ => panic!("Unexpected event"),
5166         }
5167         match msg_events[1] {
5168                 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, .. } } => {
5169                         assert!(update_add_htlcs.is_empty());
5170                         assert!(update_fail_htlcs.is_empty());
5171                         assert_eq!(update_fulfill_htlcs.len(), 1);
5172                         assert!(update_fail_malformed_htlcs.is_empty());
5173                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
5174                 },
5175                 _ => panic!("Unexpected event"),
5176         };
5177         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
5178         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
5179         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
5180         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5181         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
5182         assert_eq!(b_txn.len(), 3);
5183         check_spends!(b_txn[1], chan_1.3);
5184         check_spends!(b_txn[2], b_txn[1]);
5185         check_spends!(b_txn[0], commitment_tx[0]);
5186         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5187         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
5188         assert_eq!(b_txn[0].lock_time, 0); // Success tx
5189
5190         check_closed_broadcast!(nodes[1], false);
5191         check_added_monitors!(nodes[1], 1);
5192 }
5193
5194 #[test]
5195 fn test_duplicate_payment_hash_one_failure_one_success() {
5196         // Topology : A --> B --> C
5197         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
5198         let chanmon_cfgs = create_chanmon_cfgs(3);
5199         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5200         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5201         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5202
5203         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5204         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5205
5206         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
5207         *nodes[0].network_payment_count.borrow_mut() -= 1;
5208         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
5209
5210         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
5211         assert_eq!(commitment_txn[0].input.len(), 1);
5212         check_spends!(commitment_txn[0], chan_2.3);
5213
5214         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5215         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5216         check_closed_broadcast!(nodes[1], false);
5217         check_added_monitors!(nodes[1], 1);
5218
5219         let htlc_timeout_tx;
5220         { // Extract one of the two HTLC-Timeout transaction
5221                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5222                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
5223                 assert_eq!(node_txn.len(), 5);
5224                 check_spends!(node_txn[0], commitment_txn[0]);
5225                 assert_eq!(node_txn[0].input.len(), 1);
5226                 check_spends!(node_txn[1], commitment_txn[0]);
5227                 assert_eq!(node_txn[1].input.len(), 1);
5228                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
5229                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5230                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5231                 check_spends!(node_txn[2], chan_2.3);
5232                 check_spends!(node_txn[3], node_txn[2]);
5233                 check_spends!(node_txn[4], node_txn[2]);
5234                 htlc_timeout_tx = node_txn[1].clone();
5235         }
5236
5237         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
5238         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
5239         check_added_monitors!(nodes[2], 3);
5240         let events = nodes[2].node.get_and_clear_pending_msg_events();
5241         match events[0] {
5242                 MessageSendEvent::UpdateHTLCs { .. } => {},
5243                 _ => panic!("Unexpected event"),
5244         }
5245         match events[1] {
5246                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5247                 _ => panic!("Unexepected event"),
5248         }
5249         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
5250         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)
5251         check_spends!(htlc_success_txn[2], chan_2.3);
5252         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
5253         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
5254         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
5255         assert_eq!(htlc_success_txn[0].input.len(), 1);
5256         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5257         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
5258         assert_eq!(htlc_success_txn[1].input.len(), 1);
5259         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5260         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
5261         check_spends!(htlc_success_txn[0], commitment_txn[0]);
5262         check_spends!(htlc_success_txn[1], commitment_txn[0]);
5263
5264         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
5265         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
5266         expect_pending_htlcs_forwardable!(nodes[1]);
5267         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5268         assert!(htlc_updates.update_add_htlcs.is_empty());
5269         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
5270         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
5271         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
5272         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
5273         check_added_monitors!(nodes[1], 1);
5274
5275         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
5276         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5277         {
5278                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
5279                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5280                 assert_eq!(events.len(), 1);
5281                 match events[0] {
5282                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
5283                         },
5284                         _ => { panic!("Unexpected event"); }
5285                 }
5286         }
5287         expect_payment_failed!(nodes[0], duplicate_payment_hash, false);
5288
5289         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
5290         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
5291         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5292         assert!(updates.update_add_htlcs.is_empty());
5293         assert!(updates.update_fail_htlcs.is_empty());
5294         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5295         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
5296         assert!(updates.update_fail_malformed_htlcs.is_empty());
5297         check_added_monitors!(nodes[1], 1);
5298
5299         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
5300         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
5301
5302         let events = nodes[0].node.get_and_clear_pending_events();
5303         match events[0] {
5304                 Event::PaymentSent { ref payment_preimage } => {
5305                         assert_eq!(*payment_preimage, our_payment_preimage);
5306                 }
5307                 _ => panic!("Unexpected event"),
5308         }
5309 }
5310
5311 #[test]
5312 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
5313         let chanmon_cfgs = create_chanmon_cfgs(2);
5314         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5315         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5316         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5317
5318         // Create some initial channels
5319         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5320
5321         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
5322         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
5323         assert_eq!(local_txn[0].input.len(), 1);
5324         check_spends!(local_txn[0], chan_1.3);
5325
5326         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
5327         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
5328         check_added_monitors!(nodes[1], 1);
5329         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5330         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
5331         check_added_monitors!(nodes[1], 1);
5332         let events = nodes[1].node.get_and_clear_pending_msg_events();
5333         match events[0] {
5334                 MessageSendEvent::UpdateHTLCs { .. } => {},
5335                 _ => panic!("Unexpected event"),
5336         }
5337         match events[1] {
5338                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5339                 _ => panic!("Unexepected event"),
5340         }
5341         let node_txn = {
5342                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5343                 assert_eq!(node_txn[0].input.len(), 1);
5344                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5345                 check_spends!(node_txn[0], local_txn[0]);
5346                 vec![node_txn[0].clone(), node_txn[2].clone()]
5347         };
5348
5349         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5350         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
5351         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5352
5353         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
5354         let spend_txn = check_spendable_outputs!(nodes[1], 1, node_cfgs[1].keys_manager, 100000);
5355         assert_eq!(spend_txn.len(), 2);
5356         check_spends!(spend_txn[0], node_txn[0]);
5357         check_spends!(spend_txn[1], node_txn[1]);
5358 }
5359
5360 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
5361         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
5362         // unrevoked commitment transaction.
5363         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
5364         // a remote RAA before they could be failed backwards (and combinations thereof).
5365         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
5366         // use the same payment hashes.
5367         // Thus, we use a six-node network:
5368         //
5369         // A \         / E
5370         //    - C - D -
5371         // B /         \ F
5372         // And test where C fails back to A/B when D announces its latest commitment transaction
5373         let chanmon_cfgs = create_chanmon_cfgs(6);
5374         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
5375         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
5376         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
5377         let logger = test_utils::TestLogger::new();
5378
5379         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5380         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
5381         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known());
5382         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::known(), InitFeatures::known());
5383         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::known(), InitFeatures::known());
5384
5385         // Rebalance and check output sanity...
5386         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
5387         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
5388         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
5389
5390         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5391         // 0th HTLC:
5392         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
5393         // 1st HTLC:
5394         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
5395         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
5396         let our_node_id = &nodes[1].node.get_our_node_id();
5397         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();
5398         // 2nd HTLC:
5399         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
5400         // 3rd HTLC:
5401         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
5402         // 4th HTLC:
5403         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5404         // 5th HTLC:
5405         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5406         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();
5407         // 6th HTLC:
5408         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
5409         // 7th HTLC:
5410         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
5411
5412         // 8th HTLC:
5413         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
5414         // 9th HTLC:
5415         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();
5416         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
5417
5418         // 10th HTLC:
5419         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
5420         // 11th HTLC:
5421         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();
5422         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
5423
5424         // Double-check that six of the new HTLC were added
5425         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
5426         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
5427         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
5428         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
5429
5430         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
5431         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
5432         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
5433         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
5434         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
5435         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
5436         check_added_monitors!(nodes[4], 0);
5437         expect_pending_htlcs_forwardable!(nodes[4]);
5438         check_added_monitors!(nodes[4], 1);
5439
5440         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
5441         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
5442         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
5443         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
5444         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
5445         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
5446
5447         // Fail 3rd below-dust and 7th above-dust HTLCs
5448         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
5449         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
5450         check_added_monitors!(nodes[5], 0);
5451         expect_pending_htlcs_forwardable!(nodes[5]);
5452         check_added_monitors!(nodes[5], 1);
5453
5454         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
5455         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
5456         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
5457         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
5458
5459         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5460
5461         expect_pending_htlcs_forwardable!(nodes[3]);
5462         check_added_monitors!(nodes[3], 1);
5463         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
5464         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
5465         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
5466         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
5467         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
5468         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
5469         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
5470         if deliver_last_raa {
5471                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
5472         } else {
5473                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
5474         }
5475
5476         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
5477         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
5478         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
5479         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
5480         //
5481         // We now broadcast the latest commitment transaction, which *should* result in failures for
5482         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
5483         // the non-broadcast above-dust HTLCs.
5484         //
5485         // Alternatively, we may broadcast the previous commitment transaction, which should only
5486         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
5487         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
5488
5489         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5490         if announce_latest {
5491                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
5492         } else {
5493                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
5494         }
5495         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
5496         check_closed_broadcast!(nodes[2], false);
5497         expect_pending_htlcs_forwardable!(nodes[2]);
5498         check_added_monitors!(nodes[2], 3);
5499
5500         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
5501         assert_eq!(cs_msgs.len(), 2);
5502         let mut a_done = false;
5503         for msg in cs_msgs {
5504                 match msg {
5505                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5506                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
5507                                 // should be failed-backwards here.
5508                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
5509                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
5510                                         for htlc in &updates.update_fail_htlcs {
5511                                                 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 });
5512                                         }
5513                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
5514                                         assert!(!a_done);
5515                                         a_done = true;
5516                                         &nodes[0]
5517                                 } else {
5518                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
5519                                         for htlc in &updates.update_fail_htlcs {
5520                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
5521                                         }
5522                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5523                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
5524                                         &nodes[1]
5525                                 };
5526                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
5527                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
5528                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
5529                                 if announce_latest {
5530                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
5531                                         if *node_id == nodes[0].node.get_our_node_id() {
5532                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
5533                                         }
5534                                 }
5535                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
5536                         },
5537                         _ => panic!("Unexpected event"),
5538                 }
5539         }
5540
5541         let as_events = nodes[0].node.get_and_clear_pending_events();
5542         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
5543         let mut as_failds = HashSet::new();
5544         for event in as_events.iter() {
5545                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5546                         assert!(as_failds.insert(*payment_hash));
5547                         if *payment_hash != payment_hash_2 {
5548                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5549                         } else {
5550                                 assert!(!rejected_by_dest);
5551                         }
5552                 } else { panic!("Unexpected event"); }
5553         }
5554         assert!(as_failds.contains(&payment_hash_1));
5555         assert!(as_failds.contains(&payment_hash_2));
5556         if announce_latest {
5557                 assert!(as_failds.contains(&payment_hash_3));
5558                 assert!(as_failds.contains(&payment_hash_5));
5559         }
5560         assert!(as_failds.contains(&payment_hash_6));
5561
5562         let bs_events = nodes[1].node.get_and_clear_pending_events();
5563         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
5564         let mut bs_failds = HashSet::new();
5565         for event in bs_events.iter() {
5566                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
5567                         assert!(bs_failds.insert(*payment_hash));
5568                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
5569                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
5570                         } else {
5571                                 assert!(!rejected_by_dest);
5572                         }
5573                 } else { panic!("Unexpected event"); }
5574         }
5575         assert!(bs_failds.contains(&payment_hash_1));
5576         assert!(bs_failds.contains(&payment_hash_2));
5577         if announce_latest {
5578                 assert!(bs_failds.contains(&payment_hash_4));
5579         }
5580         assert!(bs_failds.contains(&payment_hash_5));
5581
5582         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
5583         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
5584         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
5585         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
5586         // PaymentFailureNetworkUpdates.
5587         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
5588         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
5589         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
5590         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
5591         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
5592                 match event {
5593                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
5594                         _ => panic!("Unexpected event"),
5595                 }
5596         }
5597 }
5598
5599 #[test]
5600 fn test_fail_backwards_latest_remote_announce_a() {
5601         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5602 }
5603
5604 #[test]
5605 fn test_fail_backwards_latest_remote_announce_b() {
5606         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5607 }
5608
5609 #[test]
5610 fn test_fail_backwards_previous_remote_announce() {
5611         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5612         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5613         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5614 }
5615
5616 #[test]
5617 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5618         let chanmon_cfgs = create_chanmon_cfgs(2);
5619         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5620         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5621         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5622
5623         // Create some initial channels
5624         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5625
5626         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5627         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5628         assert_eq!(local_txn[0].input.len(), 1);
5629         check_spends!(local_txn[0], chan_1.3);
5630
5631         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5632         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5633         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5634         check_closed_broadcast!(nodes[0], false);
5635         check_added_monitors!(nodes[0], 1);
5636
5637         let htlc_timeout = {
5638                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5639                 assert_eq!(node_txn[0].input.len(), 1);
5640                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5641                 check_spends!(node_txn[0], local_txn[0]);
5642                 node_txn[0].clone()
5643         };
5644
5645         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5646         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5647         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5648         expect_payment_failed!(nodes[0], our_payment_hash, true);
5649
5650         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5651         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
5652         assert_eq!(spend_txn.len(), 3);
5653         assert_eq!(spend_txn[0], spend_txn[1]);
5654         check_spends!(spend_txn[0], local_txn[0]);
5655         check_spends!(spend_txn[2], htlc_timeout);
5656 }
5657
5658 #[test]
5659 fn test_key_derivation_params() {
5660         // This test is a copy of test_dynamic_spendable_outputs_local_htlc_timeout_tx, with
5661         // a key manager rotation to test that key_derivation_params returned in DynamicOutputP2WSH
5662         // let us re-derive the channel key set to then derive a delayed_payment_key.
5663
5664         let chanmon_cfgs = create_chanmon_cfgs(3);
5665
5666         // We manually create the node configuration to backup the seed.
5667         let seed = [42; 32];
5668         let keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5669         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);
5670         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 };
5671         let mut node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5672         node_cfgs.remove(0);
5673         node_cfgs.insert(0, node);
5674
5675         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5676         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5677
5678         // Create some initial channels
5679         // Create a dummy channel to advance index by one and thus test re-derivation correctness
5680         // for node 0
5681         let chan_0 = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known());
5682         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5683         assert_ne!(chan_0.3.output[0].script_pubkey, chan_1.3.output[0].script_pubkey);
5684
5685         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5686         let local_txn_0 = get_local_commitment_txn!(nodes[0], chan_0.2);
5687         let local_txn_1 = get_local_commitment_txn!(nodes[0], chan_1.2);
5688         assert_eq!(local_txn_1[0].input.len(), 1);
5689         check_spends!(local_txn_1[0], chan_1.3);
5690
5691         // We check funding pubkey are unique
5692         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]));
5693         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]));
5694         if from_0_funding_key_0 == from_1_funding_key_0
5695             || from_0_funding_key_0 == from_1_funding_key_1
5696             || from_0_funding_key_1 == from_1_funding_key_0
5697             || from_0_funding_key_1 == from_1_funding_key_1 {
5698                 panic!("Funding pubkeys aren't unique");
5699         }
5700
5701         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5702         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5703         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn_1[0].clone()] }, 200);
5704         check_closed_broadcast!(nodes[0], false);
5705         check_added_monitors!(nodes[0], 1);
5706
5707         let htlc_timeout = {
5708                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5709                 assert_eq!(node_txn[0].input.len(), 1);
5710                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5711                 check_spends!(node_txn[0], local_txn_1[0]);
5712                 node_txn[0].clone()
5713         };
5714
5715         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5716         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5717         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5718         expect_payment_failed!(nodes[0], our_payment_hash, true);
5719
5720         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5721         let new_keys_manager = test_utils::TestKeysInterface::new(&seed, Network::Testnet);
5722         let spend_txn = check_spendable_outputs!(nodes[0], 1, new_keys_manager, 100000);
5723         assert_eq!(spend_txn.len(), 3);
5724         assert_eq!(spend_txn[0], spend_txn[1]);
5725         check_spends!(spend_txn[0], local_txn_1[0]);
5726         check_spends!(spend_txn[2], htlc_timeout);
5727 }
5728
5729 #[test]
5730 fn test_static_output_closing_tx() {
5731         let chanmon_cfgs = create_chanmon_cfgs(2);
5732         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5733         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5734         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5735
5736         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5737
5738         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5739         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5740
5741         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5742         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5743         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5744
5745         let spend_txn = check_spendable_outputs!(nodes[0], 2, node_cfgs[0].keys_manager, 100000);
5746         assert_eq!(spend_txn.len(), 1);
5747         check_spends!(spend_txn[0], closing_tx);
5748
5749         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5750         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5751
5752         let spend_txn = check_spendable_outputs!(nodes[1], 2, node_cfgs[1].keys_manager, 100000);
5753         assert_eq!(spend_txn.len(), 1);
5754         check_spends!(spend_txn[0], closing_tx);
5755 }
5756
5757 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5758         let chanmon_cfgs = create_chanmon_cfgs(2);
5759         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5760         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5761         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5762         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5763
5764         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5765
5766         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5767         // present in B's local commitment transaction, but none of A's commitment transactions.
5768         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5769         check_added_monitors!(nodes[1], 1);
5770
5771         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5772         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5773         let events = nodes[0].node.get_and_clear_pending_events();
5774         assert_eq!(events.len(), 1);
5775         match events[0] {
5776                 Event::PaymentSent { payment_preimage } => {
5777                         assert_eq!(payment_preimage, our_payment_preimage);
5778                 },
5779                 _ => panic!("Unexpected event"),
5780         }
5781
5782         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5783         check_added_monitors!(nodes[0], 1);
5784         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5785         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5786         check_added_monitors!(nodes[1], 1);
5787
5788         let mut block = Block {
5789                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5790                 txdata: vec![],
5791         };
5792         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5793                 nodes[1].block_notifier.block_connected(&block, i);
5794                 block.header.prev_blockhash = block.bitcoin_hash();
5795         }
5796         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5797         check_closed_broadcast!(nodes[1], false);
5798         check_added_monitors!(nodes[1], 1);
5799 }
5800
5801 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5802         let chanmon_cfgs = create_chanmon_cfgs(2);
5803         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5804         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5805         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5806         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5807         let logger = test_utils::TestLogger::new();
5808
5809         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5810         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
5811         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();
5812         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5813         check_added_monitors!(nodes[0], 1);
5814
5815         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5816
5817         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5818         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5819         // to "time out" the HTLC.
5820
5821         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5822
5823         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5824                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5825                 header.prev_blockhash = header.bitcoin_hash();
5826         }
5827         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5828         check_closed_broadcast!(nodes[0], false);
5829         check_added_monitors!(nodes[0], 1);
5830 }
5831
5832 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5833         let chanmon_cfgs = create_chanmon_cfgs(3);
5834         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5835         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5836         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5837         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
5838
5839         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5840         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5841         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5842         // actually revoked.
5843         let htlc_value = if use_dust { 50000 } else { 3000000 };
5844         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5845         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5846         expect_pending_htlcs_forwardable!(nodes[1]);
5847         check_added_monitors!(nodes[1], 1);
5848
5849         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5850         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5851         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5852         check_added_monitors!(nodes[0], 1);
5853         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5854         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5855         check_added_monitors!(nodes[1], 1);
5856         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5857         check_added_monitors!(nodes[1], 1);
5858         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5859
5860         if check_revoke_no_close {
5861                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5862                 check_added_monitors!(nodes[0], 1);
5863         }
5864
5865         let mut block = Block {
5866                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5867                 txdata: vec![],
5868         };
5869         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5870                 nodes[0].block_notifier.block_connected(&block, i);
5871                 block.header.prev_blockhash = block.bitcoin_hash();
5872         }
5873         if !check_revoke_no_close {
5874                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5875                 check_closed_broadcast!(nodes[0], false);
5876                 check_added_monitors!(nodes[0], 1);
5877         } else {
5878                 expect_payment_failed!(nodes[0], our_payment_hash, true);
5879         }
5880 }
5881
5882 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5883 // There are only a few cases to test here:
5884 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5885 //    broadcastable commitment transactions result in channel closure,
5886 //  * its included in an unrevoked-but-previous remote commitment transaction,
5887 //  * its included in the latest remote or local commitment transactions.
5888 // We test each of the three possible commitment transactions individually and use both dust and
5889 // non-dust HTLCs.
5890 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5891 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5892 // tested for at least one of the cases in other tests.
5893 #[test]
5894 fn htlc_claim_single_commitment_only_a() {
5895         do_htlc_claim_local_commitment_only(true);
5896         do_htlc_claim_local_commitment_only(false);
5897
5898         do_htlc_claim_current_remote_commitment_only(true);
5899         do_htlc_claim_current_remote_commitment_only(false);
5900 }
5901
5902 #[test]
5903 fn htlc_claim_single_commitment_only_b() {
5904         do_htlc_claim_previous_remote_commitment_only(true, false);
5905         do_htlc_claim_previous_remote_commitment_only(false, false);
5906         do_htlc_claim_previous_remote_commitment_only(true, true);
5907         do_htlc_claim_previous_remote_commitment_only(false, true);
5908 }
5909
5910 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>)
5911         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5912                                 F2: FnMut(),
5913 {
5914         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);
5915 }
5916
5917 // test_case
5918 // 0: node1 fails backward
5919 // 1: final node fails backward
5920 // 2: payment completed but the user rejects the payment
5921 // 3: final node fails backward (but tamper onion payloads from node0)
5922 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5923 // 200: trigger error in the final node and tamper returning fail_htlc
5924 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>)
5925         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5926                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5927                                 F3: FnMut(),
5928 {
5929
5930         // reset block height
5931         let block = Block {
5932                 header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
5933                 txdata: vec![],
5934         };
5935         for ix in 0..nodes.len() {
5936                 nodes[ix].block_notifier.block_connected(&block, 1);
5937         }
5938
5939         macro_rules! expect_event {
5940                 ($node: expr, $event_type: path) => {{
5941                         let events = $node.node.get_and_clear_pending_events();
5942                         assert_eq!(events.len(), 1);
5943                         match events[0] {
5944                                 $event_type { .. } => {},
5945                                 _ => panic!("Unexpected event"),
5946                         }
5947                 }}
5948         }
5949
5950         macro_rules! expect_htlc_forward {
5951                 ($node: expr) => {{
5952                         expect_event!($node, Event::PendingHTLCsForwardable);
5953                         $node.node.process_pending_htlc_forwards();
5954                 }}
5955         }
5956
5957         // 0 ~~> 2 send payment
5958         nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5959         check_added_monitors!(nodes[0], 1);
5960         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5961         // temper update_add (0 => 1)
5962         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5963         if test_case == 0 || test_case == 3 || test_case == 100 {
5964                 callback_msg(&mut update_add_0);
5965                 callback_node();
5966         }
5967         // 0 => 1 update_add & CS
5968         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5969         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5970
5971         let update_1_0 = match test_case {
5972                 0|100 => { // intermediate node failure; fail backward to 0
5973                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5974                         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));
5975                         update_1_0
5976                 },
5977                 1|2|3|200 => { // final node failure; forwarding to 2
5978                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5979                         // forwarding on 1
5980                         if test_case != 200 {
5981                                 callback_node();
5982                         }
5983                         expect_htlc_forward!(&nodes[1]);
5984
5985                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5986                         check_added_monitors!(&nodes[1], 1);
5987                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5988                         // tamper update_add (1 => 2)
5989                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5990                         if test_case != 3 && test_case != 200 {
5991                                 callback_msg(&mut update_add_1);
5992                         }
5993
5994                         // 1 => 2
5995                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5996                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5997
5998                         if test_case == 2 || test_case == 200 {
5999                                 expect_htlc_forward!(&nodes[2]);
6000                                 expect_event!(&nodes[2], Event::PaymentReceived);
6001                                 callback_node();
6002                                 expect_pending_htlcs_forwardable!(nodes[2]);
6003                         }
6004
6005                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6006                         if test_case == 2 || test_case == 200 {
6007                                 check_added_monitors!(&nodes[2], 1);
6008                         }
6009                         assert!(update_2_1.update_fail_htlcs.len() == 1);
6010
6011                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
6012                         if test_case == 200 {
6013                                 callback_fail(&mut fail_msg);
6014                         }
6015
6016                         // 2 => 1
6017                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
6018                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
6019
6020                         // backward fail on 1
6021                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6022                         assert!(update_1_0.update_fail_htlcs.len() == 1);
6023                         update_1_0
6024                 },
6025                 _ => unreachable!(),
6026         };
6027
6028         // 1 => 0 commitment_signed_dance
6029         if update_1_0.update_fail_htlcs.len() > 0 {
6030                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
6031                 if test_case == 100 {
6032                         callback_fail(&mut fail_msg);
6033                 }
6034                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
6035         } else {
6036                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
6037         };
6038
6039         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
6040
6041         let events = nodes[0].node.get_and_clear_pending_events();
6042         assert_eq!(events.len(), 1);
6043         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
6044                 assert_eq!(*rejected_by_dest, !expected_retryable);
6045                 assert_eq!(*error_code, expected_error_code);
6046         } else {
6047                 panic!("Uexpected event");
6048         }
6049
6050         let events = nodes[0].node.get_and_clear_pending_msg_events();
6051         if expected_channel_update.is_some() {
6052                 assert_eq!(events.len(), 1);
6053                 match events[0] {
6054                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
6055                                 match update {
6056                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
6057                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
6058                                                         panic!("channel_update not found!");
6059                                                 }
6060                                         },
6061                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
6062                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6063                                                         assert!(*short_channel_id == *expected_short_channel_id);
6064                                                         assert!(*is_permanent == *expected_is_permanent);
6065                                                 } else {
6066                                                         panic!("Unexpected message event");
6067                                                 }
6068                                         },
6069                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
6070                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
6071                                                         assert!(*node_id == *expected_node_id);
6072                                                         assert!(*is_permanent == *expected_is_permanent);
6073                                                 } else {
6074                                                         panic!("Unexpected message event");
6075                                                 }
6076                                         },
6077                                 }
6078                         },
6079                         _ => panic!("Unexpected message event"),
6080                 }
6081         } else {
6082                 assert_eq!(events.len(), 0);
6083         }
6084 }
6085
6086 impl msgs::ChannelUpdate {
6087         fn dummy() -> msgs::ChannelUpdate {
6088                 use bitcoin::secp256k1::ffi::Signature as FFISignature;
6089                 use bitcoin::secp256k1::Signature;
6090                 msgs::ChannelUpdate {
6091                         signature: Signature::from(FFISignature::new()),
6092                         contents: msgs::UnsignedChannelUpdate {
6093                                 chain_hash: BlockHash::hash(&vec![0u8][..]),
6094                                 short_channel_id: 0,
6095                                 timestamp: 0,
6096                                 flags: 0,
6097                                 cltv_expiry_delta: 0,
6098                                 htlc_minimum_msat: 0,
6099                                 htlc_maximum_msat: OptionalField::Absent,
6100                                 fee_base_msat: 0,
6101                                 fee_proportional_millionths: 0,
6102                                 excess_data: vec![],
6103                         }
6104                 }
6105         }
6106 }
6107
6108 struct BogusOnionHopData {
6109         data: Vec<u8>
6110 }
6111 impl BogusOnionHopData {
6112         fn new(orig: msgs::OnionHopData) -> Self {
6113                 Self { data: orig.encode() }
6114         }
6115 }
6116 impl Writeable for BogusOnionHopData {
6117         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
6118                 writer.write_all(&self.data[..])
6119         }
6120 }
6121
6122 #[test]
6123 fn test_onion_failure() {
6124         use ln::msgs::ChannelUpdate;
6125         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
6126         use bitcoin::secp256k1;
6127
6128         const BADONION: u16 = 0x8000;
6129         const PERM: u16 = 0x4000;
6130         const NODE: u16 = 0x2000;
6131         const UPDATE: u16 = 0x1000;
6132
6133         let chanmon_cfgs = create_chanmon_cfgs(3);
6134         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6135         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6136         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6137         for node in nodes.iter() {
6138                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
6139         }
6140         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())];
6141         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
6142         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6143         let logger = test_utils::TestLogger::new();
6144         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();
6145         // positve case
6146         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
6147
6148         // intermediate node failure
6149         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
6150                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6151                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6152                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6153                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6154                 let mut new_payloads = Vec::new();
6155                 for payload in onion_payloads.drain(..) {
6156                         new_payloads.push(BogusOnionHopData::new(payload));
6157                 }
6158                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
6159                 // describing a length-1 TLV payload, which is obviously bogus.
6160                 new_payloads[0].data[0] = 1;
6161                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6162         }, ||{}, 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
6163
6164         // final node failure
6165         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
6166                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6167                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6168                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6169                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
6170                 let mut new_payloads = Vec::new();
6171                 for payload in onion_payloads.drain(..) {
6172                         new_payloads.push(BogusOnionHopData::new(payload));
6173                 }
6174                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
6175                 // length-1 TLV payload, which is obviously bogus.
6176                 new_payloads[1].data[0] = 1;
6177                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
6178         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6179
6180         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
6181         // receiving simulated fail messages
6182         // intermediate node failure
6183         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6184                 // trigger error
6185                 msg.amount_msat -= 1;
6186         }, |msg| {
6187                 // and tamper returning error message
6188                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6189                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6190                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
6191         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
6192
6193         // final node failure
6194         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6195                 // and tamper returning error message
6196                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6197                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6198                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
6199         }, ||{
6200                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6201         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
6202
6203         // intermediate node failure
6204         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
6205                 msg.amount_msat -= 1;
6206         }, |msg| {
6207                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6208                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6209                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
6210         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6211
6212         // final node failure
6213         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |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[1].shared_secret[..], PERM|NODE|2, &[0;0]);
6217         }, ||{
6218                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6219         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6220
6221         // intermediate node failure
6222         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6223                 msg.amount_msat -= 1;
6224         }, |msg| {
6225                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6226                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6227                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
6228         }, ||{
6229                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6230         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
6231
6232         // final node failure
6233         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
6234                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6235                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6236                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
6237         }, ||{
6238                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6239         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
6240
6241         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
6242                 Some(BADONION|PERM|4), None);
6243
6244         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
6245                 Some(BADONION|PERM|5), None);
6246
6247         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
6248                 Some(BADONION|PERM|6), None);
6249
6250         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6251                 msg.amount_msat -= 1;
6252         }, |msg| {
6253                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6254                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6255                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
6256         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6257
6258         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
6259                 msg.amount_msat -= 1;
6260         }, |msg| {
6261                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6262                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6263                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
6264                 // short_channel_id from the processing node
6265         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6266
6267         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
6268                 msg.amount_msat -= 1;
6269         }, |msg| {
6270                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6271                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6272                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
6273                 // short_channel_id from the processing node
6274         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
6275
6276         let mut bogus_route = route.clone();
6277         bogus_route.paths[0][1].short_channel_id -= 1;
6278         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
6279           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
6280
6281         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
6282         let mut bogus_route = route.clone();
6283         let route_len = bogus_route.paths[0].len();
6284         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
6285         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6286
6287         //TODO: with new config API, we will be able to generate both valid and
6288         //invalid channel_update cases.
6289         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
6290                 msg.amount_msat -= 1;
6291         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6292
6293         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
6294                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
6295                 msg.cltv_expiry -= 1;
6296         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
6297
6298         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
6299                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6300                 let block = Block {
6301                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6302                         txdata: vec![],
6303                 };
6304
6305                 nodes[1].block_notifier.block_connected(&block, height);
6306         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6307
6308         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
6309                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
6310         }, false, Some(PERM|15), None);
6311
6312         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
6313                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
6314                 let block = Block {
6315                         header: BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 },
6316                         txdata: vec![],
6317                 };
6318
6319                 nodes[2].block_notifier.block_connected(&block, height);
6320         }, || {}, true, Some(17), None);
6321
6322         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
6323                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6324                         for f in pending_forwards.iter_mut() {
6325                                 match f {
6326                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6327                                                 forward_info.outgoing_cltv_value += 1,
6328                                         _ => {},
6329                                 }
6330                         }
6331                 }
6332         }, true, Some(18), None);
6333
6334         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
6335                 // violate amt_to_forward > msg.amount_msat
6336                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
6337                         for f in pending_forwards.iter_mut() {
6338                                 match f {
6339                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
6340                                                 forward_info.amt_to_forward -= 1,
6341                                         _ => {},
6342                                 }
6343                         }
6344                 }
6345         }, true, Some(19), None);
6346
6347         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
6348                 // disconnect event to the channel between nodes[1] ~ nodes[2]
6349                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
6350                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6351         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
6352         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6353
6354         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
6355                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
6356                 let mut route = route.clone();
6357                 let height = 1;
6358                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
6359                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
6360                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
6361                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
6362                 msg.cltv_expiry = htlc_cltv;
6363                 msg.onion_routing_packet = onion_packet;
6364         }, ||{}, true, Some(21), None);
6365 }
6366
6367 #[test]
6368 #[should_panic]
6369 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
6370         let chanmon_cfgs = create_chanmon_cfgs(2);
6371         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6372         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6373         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6374         //Force duplicate channel ids
6375         for node in nodes.iter() {
6376                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
6377         }
6378
6379         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
6380         let channel_value_satoshis=10000;
6381         let push_msat=10001;
6382         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
6383         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6384         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &node0_to_1_send_open_channel);
6385
6386         //Create a second channel with a channel_id collision
6387         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6388 }
6389
6390 #[test]
6391 fn bolt2_open_channel_sending_node_checks_part2() {
6392         let chanmon_cfgs = create_chanmon_cfgs(2);
6393         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6394         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6395         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6396
6397         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
6398         let channel_value_satoshis=2^24;
6399         let push_msat=10001;
6400         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6401
6402         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
6403         let channel_value_satoshis=10000;
6404         // Test when push_msat is equal to 1000 * funding_satoshis.
6405         let push_msat=1000*channel_value_satoshis+1;
6406         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
6407
6408         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
6409         let channel_value_satoshis=10000;
6410         let push_msat=10001;
6411         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
6412         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
6413         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
6414
6415         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
6416         // 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
6417         assert!(node0_to_1_send_open_channel.channel_flags<=1);
6418
6419         // 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.
6420         assert!(BREAKDOWN_TIMEOUT>0);
6421         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
6422
6423         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
6424         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
6425         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
6426
6427         // 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.
6428         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
6429         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
6430         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
6431         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_point.serialize()).is_ok());
6432         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
6433 }
6434
6435 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
6436 // 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.
6437 //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.
6438
6439 #[test]
6440 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
6441         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
6442         let chanmon_cfgs = create_chanmon_cfgs(2);
6443         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6444         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6445         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6446         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6447
6448         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6449         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6450         let logger = test_utils::TestLogger::new();
6451         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();
6452         route.paths[0][0].fee_msat = 100;
6453
6454         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6455                 assert!(regex::Regex::new(r"Cannot send less than their minimum HTLC value \(\d+\)").unwrap().is_match(err)));
6456         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6457         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
6458 }
6459
6460 #[test]
6461 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
6462         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6463         let chanmon_cfgs = create_chanmon_cfgs(2);
6464         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6465         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6466         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6467         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6468         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6469
6470         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6471         let logger = test_utils::TestLogger::new();
6472         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();
6473         route.paths[0][0].fee_msat = 0;
6474         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6475                 assert_eq!(err, "Cannot send 0-msat HTLC"));
6476
6477         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6478         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
6479 }
6480
6481 #[test]
6482 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
6483         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
6484         let chanmon_cfgs = create_chanmon_cfgs(2);
6485         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6486         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6487         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6488         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6489
6490         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6491         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6492         let logger = test_utils::TestLogger::new();
6493         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();
6494         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6495         check_added_monitors!(nodes[0], 1);
6496         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6497         updates.update_add_htlcs[0].amount_msat = 0;
6498
6499         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6500         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
6501         check_closed_broadcast!(nodes[1], true).unwrap();
6502         check_added_monitors!(nodes[1], 1);
6503 }
6504
6505 #[test]
6506 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
6507         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
6508         //It is enforced when constructing a route.
6509         let chanmon_cfgs = create_chanmon_cfgs(2);
6510         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6511         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6512         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6513         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::known(), InitFeatures::known());
6514         let logger = test_utils::TestLogger::new();
6515
6516         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6517
6518         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6519         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();
6520         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { ref err },
6521                 assert_eq!(err, &"Channel CLTV overflowed?"));
6522 }
6523
6524 #[test]
6525 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
6526         //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.
6527         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
6528         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
6529         let chanmon_cfgs = create_chanmon_cfgs(2);
6530         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6531         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6532         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6533         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::known(), InitFeatures::known());
6534         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
6535
6536         let logger = test_utils::TestLogger::new();
6537         for i in 0..max_accepted_htlcs {
6538                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6539                 let payment_event = {
6540                         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6541                         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();
6542                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6543                         check_added_monitors!(nodes[0], 1);
6544
6545                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6546                         assert_eq!(events.len(), 1);
6547                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
6548                                 assert_eq!(htlcs[0].htlc_id, i);
6549                         } else {
6550                                 assert!(false);
6551                         }
6552                         SendEvent::from_event(events.remove(0))
6553                 };
6554                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6555                 check_added_monitors!(nodes[1], 0);
6556                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6557
6558                 expect_pending_htlcs_forwardable!(nodes[1]);
6559                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
6560         }
6561         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6562         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6563         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();
6564         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6565                 assert!(regex::Regex::new(r"Cannot push more than their max accepted HTLCs \(\d+\)").unwrap().is_match(err)));
6566
6567         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6568         nodes[0].logger.assert_log_contains("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
6569 }
6570
6571 #[test]
6572 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
6573         //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.
6574         let chanmon_cfgs = create_chanmon_cfgs(2);
6575         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6576         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6577         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6578         let channel_value = 100000;
6579         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::known(), InitFeatures::known());
6580         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
6581
6582         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
6583
6584         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6585         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6586         let logger = test_utils::TestLogger::new();
6587         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();
6588         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { ref err },
6589                 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)));
6590
6591         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6592         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);
6593
6594         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
6595 }
6596
6597 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
6598 #[test]
6599 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
6600         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
6601         let chanmon_cfgs = create_chanmon_cfgs(2);
6602         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6603         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6604         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6605         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6606         let htlc_minimum_msat: u64;
6607         {
6608                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
6609                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
6610                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
6611         }
6612
6613         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6614         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6615         let logger = test_utils::TestLogger::new();
6616         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();
6617         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6618         check_added_monitors!(nodes[0], 1);
6619         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6620         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
6621         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6622         assert!(nodes[1].node.list_channels().is_empty());
6623         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6624         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()));
6625         check_added_monitors!(nodes[1], 1);
6626 }
6627
6628 #[test]
6629 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
6630         //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
6631         let chanmon_cfgs = create_chanmon_cfgs(2);
6632         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6633         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6634         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6635         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6636         let logger = test_utils::TestLogger::new();
6637
6638         let chan_stat = get_channel_value_stat!(nodes[0], chan.2);
6639         let channel_reserve = chan_stat.channel_reserve_msat;
6640         let feerate = get_feerate!(nodes[0], chan.2);
6641         // The 2* and +1 are for the fee spike reserve.
6642         let commit_tx_fee_outbound = 2 * commit_tx_fee_msat(feerate, 1 + 1);
6643
6644         let max_can_send = 5000000 - channel_reserve - commit_tx_fee_outbound;
6645         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6646         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6647         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();
6648         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6649         check_added_monitors!(nodes[0], 1);
6650         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6651
6652         // Even though channel-initiator senders are required to respect the fee_spike_reserve,
6653         // at this time channel-initiatee receivers are not required to enforce that senders
6654         // respect the fee_spike_reserve.
6655         updates.update_add_htlcs[0].amount_msat = max_can_send + commit_tx_fee_outbound + 1;
6656         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6657
6658         assert!(nodes[1].node.list_channels().is_empty());
6659         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6660         assert_eq!(err_msg.data, "Remote HTLC add would put them under remote reserve value");
6661         check_added_monitors!(nodes[1], 1);
6662 }
6663
6664 #[test]
6665 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
6666         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
6667         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
6668         let chanmon_cfgs = create_chanmon_cfgs(2);
6669         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6670         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6671         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6672         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6673         let logger = test_utils::TestLogger::new();
6674
6675         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6676         let session_priv = SecretKey::from_slice(&[42; 32]).unwrap();
6677
6678         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6679         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();
6680
6681         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
6682         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
6683         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
6684         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
6685
6686         let mut msg = msgs::UpdateAddHTLC {
6687                 channel_id: chan.2,
6688                 htlc_id: 0,
6689                 amount_msat: 1000,
6690                 payment_hash: our_payment_hash,
6691                 cltv_expiry: htlc_cltv,
6692                 onion_routing_packet: onion_packet.clone(),
6693         };
6694
6695         for i in 0..super::channel::OUR_MAX_HTLCS {
6696                 msg.htlc_id = i as u64;
6697                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6698         }
6699         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6700         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6701
6702         assert!(nodes[1].node.list_channels().is_empty());
6703         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6704         assert!(regex::Regex::new(r"Remote tried to push more than our max accepted HTLCs \(\d+\)").unwrap().is_match(err_msg.data.as_str()));
6705         check_added_monitors!(nodes[1], 1);
6706 }
6707
6708 #[test]
6709 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6710         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6711         let chanmon_cfgs = create_chanmon_cfgs(2);
6712         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6713         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6714         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6715         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6716         let logger = test_utils::TestLogger::new();
6717
6718         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6719         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6720         let route = get_route(&nodes[0].node.get_our_node_id(), &net_graph_msg_handler.network_graph.read().unwrap(), &nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV, &logger).unwrap();
6721         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6722         check_added_monitors!(nodes[0], 1);
6723         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6724         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
6725         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6726
6727         assert!(nodes[1].node.list_channels().is_empty());
6728         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6729         assert!(regex::Regex::new("Remote HTLC add would put them over our max HTLC value").unwrap().is_match(err_msg.data.as_str()));
6730         check_added_monitors!(nodes[1], 1);
6731 }
6732
6733 #[test]
6734 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6735         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6736         let chanmon_cfgs = create_chanmon_cfgs(2);
6737         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6738         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6739         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6740         let logger = test_utils::TestLogger::new();
6741
6742         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::known(), InitFeatures::known());
6743         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6744         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6745         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();
6746         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6747         check_added_monitors!(nodes[0], 1);
6748         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6749         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6750         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6751
6752         assert!(nodes[1].node.list_channels().is_empty());
6753         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6754         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6755         check_added_monitors!(nodes[1], 1);
6756 }
6757
6758 #[test]
6759 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6760         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6761         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6762         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6763         let chanmon_cfgs = create_chanmon_cfgs(2);
6764         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6765         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6766         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6767         let logger = test_utils::TestLogger::new();
6768
6769         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6770         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6771         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6772         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();
6773         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6774         check_added_monitors!(nodes[0], 1);
6775         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6776         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6777
6778         //Disconnect and Reconnect
6779         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6780         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6781         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6782         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6783         assert_eq!(reestablish_1.len(), 1);
6784         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6785         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6786         assert_eq!(reestablish_2.len(), 1);
6787         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6788         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6789         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6790         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6791
6792         //Resend HTLC
6793         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6794         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6795         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6796         check_added_monitors!(nodes[1], 1);
6797         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6798
6799         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6800
6801         assert!(nodes[1].node.list_channels().is_empty());
6802         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6803         assert!(regex::Regex::new(r"Remote skipped HTLC ID \(skipped ID: \d+\)").unwrap().is_match(err_msg.data.as_str()));
6804         check_added_monitors!(nodes[1], 1);
6805 }
6806
6807 #[test]
6808 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6809         //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.
6810
6811         let chanmon_cfgs = create_chanmon_cfgs(2);
6812         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6813         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6814         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6815         let logger = test_utils::TestLogger::new();
6816         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6817         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6818         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6819         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();
6820         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6821
6822         check_added_monitors!(nodes[0], 1);
6823         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6824         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6825
6826         let update_msg = msgs::UpdateFulfillHTLC{
6827                 channel_id: chan.2,
6828                 htlc_id: 0,
6829                 payment_preimage: our_payment_preimage,
6830         };
6831
6832         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6833
6834         assert!(nodes[0].node.list_channels().is_empty());
6835         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6836         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()));
6837         check_added_monitors!(nodes[0], 1);
6838 }
6839
6840 #[test]
6841 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6842         //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.
6843
6844         let chanmon_cfgs = create_chanmon_cfgs(2);
6845         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6846         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6847         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6848         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6849         let logger = test_utils::TestLogger::new();
6850
6851         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6852         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6853         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();
6854         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6855         check_added_monitors!(nodes[0], 1);
6856         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6857         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6858
6859         let update_msg = msgs::UpdateFailHTLC{
6860                 channel_id: chan.2,
6861                 htlc_id: 0,
6862                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6863         };
6864
6865         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6866
6867         assert!(nodes[0].node.list_channels().is_empty());
6868         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6869         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()));
6870         check_added_monitors!(nodes[0], 1);
6871 }
6872
6873 #[test]
6874 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6875         //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.
6876
6877         let chanmon_cfgs = create_chanmon_cfgs(2);
6878         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6879         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6880         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6881         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6882         let logger = test_utils::TestLogger::new();
6883
6884         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6885         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
6886         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();
6887         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6888         check_added_monitors!(nodes[0], 1);
6889         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6890         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6891
6892         let update_msg = msgs::UpdateFailMalformedHTLC{
6893                 channel_id: chan.2,
6894                 htlc_id: 0,
6895                 sha256_of_onion: [1; 32],
6896                 failure_code: 0x8000,
6897         };
6898
6899         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6900
6901         assert!(nodes[0].node.list_channels().is_empty());
6902         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6903         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()));
6904         check_added_monitors!(nodes[0], 1);
6905 }
6906
6907 #[test]
6908 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6909         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6910
6911         let chanmon_cfgs = create_chanmon_cfgs(2);
6912         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6913         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6914         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6915         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6916
6917         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6918
6919         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6920         check_added_monitors!(nodes[1], 1);
6921
6922         let events = nodes[1].node.get_and_clear_pending_msg_events();
6923         assert_eq!(events.len(), 1);
6924         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6925                 match events[0] {
6926                         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, .. } } => {
6927                                 assert!(update_add_htlcs.is_empty());
6928                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6929                                 assert!(update_fail_htlcs.is_empty());
6930                                 assert!(update_fail_malformed_htlcs.is_empty());
6931                                 assert!(update_fee.is_none());
6932                                 update_fulfill_htlcs[0].clone()
6933                         },
6934                         _ => panic!("Unexpected event"),
6935                 }
6936         };
6937
6938         update_fulfill_msg.htlc_id = 1;
6939
6940         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6941
6942         assert!(nodes[0].node.list_channels().is_empty());
6943         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6944         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6945         check_added_monitors!(nodes[0], 1);
6946 }
6947
6948 #[test]
6949 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6950         //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.
6951
6952         let chanmon_cfgs = create_chanmon_cfgs(2);
6953         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6954         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6955         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6956         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
6957
6958         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6959
6960         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6961         check_added_monitors!(nodes[1], 1);
6962
6963         let events = nodes[1].node.get_and_clear_pending_msg_events();
6964         assert_eq!(events.len(), 1);
6965         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6966                 match events[0] {
6967                         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, .. } } => {
6968                                 assert!(update_add_htlcs.is_empty());
6969                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6970                                 assert!(update_fail_htlcs.is_empty());
6971                                 assert!(update_fail_malformed_htlcs.is_empty());
6972                                 assert!(update_fee.is_none());
6973                                 update_fulfill_htlcs[0].clone()
6974                         },
6975                         _ => panic!("Unexpected event"),
6976                 }
6977         };
6978
6979         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6980
6981         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6982
6983         assert!(nodes[0].node.list_channels().is_empty());
6984         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6985         assert!(regex::Regex::new(r"Remote tried to fulfill HTLC \(\d+\) with an incorrect preimage").unwrap().is_match(err_msg.data.as_str()));
6986         check_added_monitors!(nodes[0], 1);
6987 }
6988
6989 #[test]
6990 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6991         //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.
6992
6993         let chanmon_cfgs = create_chanmon_cfgs(2);
6994         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6995         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6996         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6997         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
6998         let logger = test_utils::TestLogger::new();
6999
7000         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7001         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7002         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();
7003         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7004         check_added_monitors!(nodes[0], 1);
7005
7006         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7007         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7008
7009         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
7010         check_added_monitors!(nodes[1], 0);
7011         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
7012
7013         let events = nodes[1].node.get_and_clear_pending_msg_events();
7014
7015         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
7016                 match events[0] {
7017                         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, .. } } => {
7018                                 assert!(update_add_htlcs.is_empty());
7019                                 assert!(update_fulfill_htlcs.is_empty());
7020                                 assert!(update_fail_htlcs.is_empty());
7021                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7022                                 assert!(update_fee.is_none());
7023                                 update_fail_malformed_htlcs[0].clone()
7024                         },
7025                         _ => panic!("Unexpected event"),
7026                 }
7027         };
7028         update_msg.failure_code &= !0x8000;
7029         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
7030
7031         assert!(nodes[0].node.list_channels().is_empty());
7032         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
7033         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
7034         check_added_monitors!(nodes[0], 1);
7035 }
7036
7037 #[test]
7038 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
7039         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
7040         //    * 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.
7041
7042         let chanmon_cfgs = create_chanmon_cfgs(3);
7043         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7044         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7045         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7046         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7047         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7048         let logger = test_utils::TestLogger::new();
7049
7050         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7051
7052         //First hop
7053         let mut payment_event = {
7054                 let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
7055                 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();
7056                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
7057                 check_added_monitors!(nodes[0], 1);
7058                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
7059                 assert_eq!(events.len(), 1);
7060                 SendEvent::from_event(events.remove(0))
7061         };
7062         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
7063         check_added_monitors!(nodes[1], 0);
7064         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7065         expect_pending_htlcs_forwardable!(nodes[1]);
7066         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7067         assert_eq!(events_2.len(), 1);
7068         check_added_monitors!(nodes[1], 1);
7069         payment_event = SendEvent::from_event(events_2.remove(0));
7070         assert_eq!(payment_event.msgs.len(), 1);
7071
7072         //Second Hop
7073         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
7074         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
7075         check_added_monitors!(nodes[2], 0);
7076         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
7077
7078         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
7079         assert_eq!(events_3.len(), 1);
7080         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
7081                 match events_3[0] {
7082                         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 } } => {
7083                                 assert!(update_add_htlcs.is_empty());
7084                                 assert!(update_fulfill_htlcs.is_empty());
7085                                 assert!(update_fail_htlcs.is_empty());
7086                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
7087                                 assert!(update_fee.is_none());
7088                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
7089                         },
7090                         _ => panic!("Unexpected event"),
7091                 }
7092         };
7093
7094         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
7095
7096         check_added_monitors!(nodes[1], 0);
7097         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
7098         expect_pending_htlcs_forwardable!(nodes[1]);
7099         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
7100         assert_eq!(events_4.len(), 1);
7101
7102         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
7103         match events_4[0] {
7104                 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, .. } } => {
7105                         assert!(update_add_htlcs.is_empty());
7106                         assert!(update_fulfill_htlcs.is_empty());
7107                         assert_eq!(update_fail_htlcs.len(), 1);
7108                         assert!(update_fail_malformed_htlcs.is_empty());
7109                         assert!(update_fee.is_none());
7110                 },
7111                 _ => panic!("Unexpected event"),
7112         };
7113
7114         check_added_monitors!(nodes[1], 1);
7115 }
7116
7117 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
7118         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
7119         // 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
7120         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
7121
7122         let chanmon_cfgs = create_chanmon_cfgs(2);
7123         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7124         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7125         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7126         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7127
7128         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7129
7130         // We route 2 dust-HTLCs between A and B
7131         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7132         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7133         route_payment(&nodes[0], &[&nodes[1]], 1000000);
7134
7135         // Cache one local commitment tx as previous
7136         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7137
7138         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
7139         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
7140         check_added_monitors!(nodes[1], 0);
7141         expect_pending_htlcs_forwardable!(nodes[1]);
7142         check_added_monitors!(nodes[1], 1);
7143
7144         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7145         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
7146         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
7147         check_added_monitors!(nodes[0], 1);
7148
7149         // Cache one local commitment tx as lastest
7150         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7151
7152         let events = nodes[0].node.get_and_clear_pending_msg_events();
7153         match events[0] {
7154                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
7155                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7156                 },
7157                 _ => panic!("Unexpected event"),
7158         }
7159         match events[1] {
7160                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
7161                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
7162                 },
7163                 _ => panic!("Unexpected event"),
7164         }
7165
7166         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
7167         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
7168         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7169
7170         if announce_latest {
7171                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
7172         } else {
7173                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
7174         }
7175
7176         check_closed_broadcast!(nodes[0], false);
7177         check_added_monitors!(nodes[0], 1);
7178
7179         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7180         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
7181         let events = nodes[0].node.get_and_clear_pending_events();
7182         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
7183         assert_eq!(events.len(), 2);
7184         let mut first_failed = false;
7185         for event in events {
7186                 match event {
7187                         Event::PaymentFailed { payment_hash, .. } => {
7188                                 if payment_hash == payment_hash_1 {
7189                                         assert!(!first_failed);
7190                                         first_failed = true;
7191                                 } else {
7192                                         assert_eq!(payment_hash, payment_hash_2);
7193                                 }
7194                         }
7195                         _ => panic!("Unexpected event"),
7196                 }
7197         }
7198 }
7199
7200 #[test]
7201 fn test_failure_delay_dust_htlc_local_commitment() {
7202         do_test_failure_delay_dust_htlc_local_commitment(true);
7203         do_test_failure_delay_dust_htlc_local_commitment(false);
7204 }
7205
7206 #[test]
7207 fn test_no_failure_dust_htlc_local_commitment() {
7208         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
7209         // prone to error, we test here that a dummy transaction don't fail them.
7210
7211         let chanmon_cfgs = create_chanmon_cfgs(2);
7212         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7213         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7214         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7215         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7216
7217         // Rebalance a bit
7218         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7219
7220         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7221         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7222
7223         // We route 2 dust-HTLCs between A and B
7224         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7225         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
7226
7227         // Build a dummy invalid transaction trying to spend a commitment tx
7228         let input = TxIn {
7229                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
7230                 script_sig: Script::new(),
7231                 sequence: 0,
7232                 witness: Vec::new(),
7233         };
7234
7235         let outp = TxOut {
7236                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
7237                 value: 10000,
7238         };
7239
7240         let dummy_tx = Transaction {
7241                 version: 2,
7242                 lock_time: 0,
7243                 input: vec![input],
7244                 output: vec![outp]
7245         };
7246
7247         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7248         nodes[0].chan_monitor.simple_monitor.block_connected(&header, &[(0, &dummy_tx)], 1);
7249         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7250         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7251         // We broadcast a few more block to check everything is all right
7252         connect_blocks(&nodes[0].block_notifier, 20, 1, true, header.bitcoin_hash());
7253         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7254         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
7255
7256         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
7257         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
7258 }
7259
7260 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
7261         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
7262         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
7263         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
7264         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
7265         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
7266         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
7267
7268         let chanmon_cfgs = create_chanmon_cfgs(3);
7269         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7270         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7271         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7272         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7273
7274         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
7275
7276         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
7277         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7278
7279         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
7280         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
7281
7282         // We revoked bs_commitment_tx
7283         if revoked {
7284                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7285                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
7286         }
7287
7288         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7289         let mut timeout_tx = Vec::new();
7290         if local {
7291                 // We fail dust-HTLC 1 by broadcast of local commitment tx
7292                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
7293                 check_closed_broadcast!(nodes[0], false);
7294                 check_added_monitors!(nodes[0], 1);
7295                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7296                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7297                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7298                 expect_payment_failed!(nodes[0], dust_hash, true);
7299                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7300                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
7301                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7302                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7303                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7304                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7305                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7306                 expect_payment_failed!(nodes[0], non_dust_hash, true);
7307         } else {
7308                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
7309                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
7310                 check_closed_broadcast!(nodes[0], false);
7311                 check_added_monitors!(nodes[0], 1);
7312                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7313                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
7314                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
7315                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7316                 if !revoked {
7317                         expect_payment_failed!(nodes[0], dust_hash, true);
7318                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
7319                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
7320                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
7321                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
7322                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7323                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
7324                         expect_payment_failed!(nodes[0], non_dust_hash, true);
7325                 } else {
7326                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
7327                         // commitment tx
7328                         let events = nodes[0].node.get_and_clear_pending_events();
7329                         assert_eq!(events.len(), 2);
7330                         let first;
7331                         match events[0] {
7332                                 Event::PaymentFailed { payment_hash, .. } => {
7333                                         if payment_hash == dust_hash { first = true; }
7334                                         else { first = false; }
7335                                 },
7336                                 _ => panic!("Unexpected event"),
7337                         }
7338                         match events[1] {
7339                                 Event::PaymentFailed { payment_hash, .. } => {
7340                                         if first { assert_eq!(payment_hash, non_dust_hash); }
7341                                         else { assert_eq!(payment_hash, dust_hash); }
7342                                 },
7343                                 _ => panic!("Unexpected event"),
7344                         }
7345                 }
7346         }
7347 }
7348
7349 #[test]
7350 fn test_sweep_outbound_htlc_failure_update() {
7351         do_test_sweep_outbound_htlc_failure_update(false, true);
7352         do_test_sweep_outbound_htlc_failure_update(false, false);
7353         do_test_sweep_outbound_htlc_failure_update(true, false);
7354 }
7355
7356 #[test]
7357 fn test_upfront_shutdown_script() {
7358         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
7359         // enforce it at shutdown message
7360
7361         let mut config = UserConfig::default();
7362         config.channel_options.announced_channel = true;
7363         config.peer_channel_config_limits.force_announced_channel_preference = false;
7364         config.channel_options.commit_upfront_shutdown_pubkey = false;
7365         let user_cfgs = [None, Some(config), None];
7366         let chanmon_cfgs = create_chanmon_cfgs(3);
7367         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7368         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
7369         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7370
7371         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
7372         let flags = InitFeatures::known();
7373         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7374         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7375         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7376         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7377         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
7378         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7379     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()));
7380         check_added_monitors!(nodes[2], 1);
7381
7382         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
7383         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
7384         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7385         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
7386         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
7387         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
7388         let events = nodes[2].node.get_and_clear_pending_msg_events();
7389         assert_eq!(events.len(), 1);
7390         match events[0] {
7391                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7392                 _ => panic!("Unexpected event"),
7393         }
7394
7395         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
7396         let flags_no = InitFeatures::known().clear_upfront_shutdown_script();
7397         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
7398         nodes[0].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7399         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
7400         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7401         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
7402         let events = nodes[1].node.get_and_clear_pending_msg_events();
7403         assert_eq!(events.len(), 1);
7404         match events[0] {
7405                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
7406                 _ => panic!("Unexpected event"),
7407         }
7408
7409         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7410         // channel smoothly, opt-out is from channel initiator here
7411         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
7412         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7413         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7414         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7415         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7416         let events = nodes[0].node.get_and_clear_pending_msg_events();
7417         assert_eq!(events.len(), 1);
7418         match events[0] {
7419                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7420                 _ => panic!("Unexpected event"),
7421         }
7422
7423         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
7424         //// channel smoothly
7425         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
7426         nodes[1].node.close_channel(&OutPoint { txid: chan.3.txid(), index: 0 }.to_channel_id()).unwrap();
7427         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
7428         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
7429         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
7430         let events = nodes[0].node.get_and_clear_pending_msg_events();
7431         assert_eq!(events.len(), 2);
7432         match events[0] {
7433                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7434                 _ => panic!("Unexpected event"),
7435         }
7436         match events[1] {
7437                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
7438                 _ => panic!("Unexpected event"),
7439         }
7440 }
7441
7442 #[test]
7443 fn test_user_configurable_csv_delay() {
7444         // We test our channel constructors yield errors when we pass them absurd csv delay
7445
7446         let mut low_our_to_self_config = UserConfig::default();
7447         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
7448         let mut high_their_to_self_config = UserConfig::default();
7449         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
7450         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
7451         let chanmon_cfgs = create_chanmon_cfgs(2);
7452         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7453         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
7454         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7455
7456         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
7457         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet));
7458         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) {
7459                 match error {
7460                         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())); },
7461                         _ => panic!("Unexpected event"),
7462                 }
7463         } else { assert!(false) }
7464
7465         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
7466         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7467         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7468         open_channel.to_self_delay = 200;
7469         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) {
7470                 match error {
7471                         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()));  },
7472                         _ => panic!("Unexpected event"),
7473                 }
7474         } else { assert!(false); }
7475
7476         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
7477         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7478         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()));
7479         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7480         accept_channel.to_self_delay = 200;
7481         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::known(), &accept_channel);
7482         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
7483                 match action {
7484                         &ErrorAction::SendErrorMessage { ref msg } => {
7485                                 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()));
7486                         },
7487                         _ => { assert!(false); }
7488                 }
7489         } else { assert!(false); }
7490
7491         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
7492         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
7493         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
7494         open_channel.to_self_delay = 200;
7495         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) {
7496                 match error {
7497                         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())); },
7498                         _ => panic!("Unexpected event"),
7499                 }
7500         } else { assert!(false); }
7501 }
7502
7503 #[test]
7504 fn test_data_loss_protect() {
7505         // We want to be sure that :
7506         // * we don't broadcast our Local Commitment Tx in case of fallen behind
7507         // * we close channel in case of detecting other being fallen behind
7508         // * we are able to claim our own outputs thanks to to_remote being static
7509         let keys_manager;
7510         let logger;
7511         let fee_estimator;
7512         let tx_broadcaster;
7513         let chain_monitor;
7514         let monitor;
7515         let node_state_0;
7516         let chanmon_cfgs = create_chanmon_cfgs(2);
7517         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7518         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7519         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7520
7521         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::known(), InitFeatures::known());
7522
7523         // Cache node A state before any channel update
7524         let previous_node_state = nodes[0].node.encode();
7525         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
7526         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
7527
7528         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7529         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
7530
7531         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7532         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7533
7534         // Restore node A from previous state
7535         logger = test_utils::TestLogger::with_id(format!("node {}", 0));
7536         let mut chan_monitor = <(BlockHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0)).unwrap().1;
7537         chain_monitor = ChainWatchInterfaceUtil::new(Network::Testnet);
7538         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
7539         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
7540         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet);
7541         monitor = test_utils::TestChannelMonitor::new(&chain_monitor, &tx_broadcaster, &logger, &fee_estimator);
7542         node_state_0 = {
7543                 let mut channel_monitors = HashMap::new();
7544                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
7545                 <(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 {
7546                         keys_manager: &keys_manager,
7547                         fee_estimator: &fee_estimator,
7548                         monitor: &monitor,
7549                         logger: &logger,
7550                         tx_broadcaster: &tx_broadcaster,
7551                         default_config: UserConfig::default(),
7552                         channel_monitors: &mut channel_monitors,
7553                 }).unwrap().1
7554         };
7555         nodes[0].node = &node_state_0;
7556         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
7557         nodes[0].chan_monitor = &monitor;
7558         nodes[0].chain_monitor = &chain_monitor;
7559
7560         nodes[0].block_notifier = BlockNotifier::new();
7561         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
7562         nodes[0].block_notifier.register_listener(nodes[0].node);
7563
7564         check_added_monitors!(nodes[0], 1);
7565
7566         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7567         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7568
7569         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7570
7571         // Check we don't broadcast any transactions following learning of per_commitment_point from B
7572         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
7573         check_added_monitors!(nodes[0], 1);
7574
7575         {
7576                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7577                 assert_eq!(node_txn.len(), 0);
7578         }
7579
7580         let mut reestablish_1 = Vec::with_capacity(1);
7581         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
7582                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
7583                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7584                         reestablish_1.push(msg.clone());
7585                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
7586                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
7587                         match action {
7588                                 &ErrorAction::SendErrorMessage { ref msg } => {
7589                                         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");
7590                                 },
7591                                 _ => panic!("Unexpected event!"),
7592                         }
7593                 } else {
7594                         panic!("Unexpected event")
7595                 }
7596         }
7597
7598         // Check we close channel detecting A is fallen-behind
7599         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7600         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
7601         check_added_monitors!(nodes[1], 1);
7602
7603
7604         // Check A is able to claim to_remote output
7605         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
7606         assert_eq!(node_txn.len(), 1);
7607         check_spends!(node_txn[0], chan.3);
7608         assert_eq!(node_txn[0].output.len(), 2);
7609         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
7610         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
7611         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
7612         let spend_txn = check_spendable_outputs!(nodes[0], 1, node_cfgs[0].keys_manager, 100000);
7613         assert_eq!(spend_txn.len(), 1);
7614         check_spends!(spend_txn[0], node_txn[0]);
7615 }
7616
7617 #[test]
7618 fn test_check_htlc_underpaying() {
7619         // Send payment through A -> B but A is maliciously
7620         // sending a probe payment (i.e less than expected value0
7621         // to B, B should refuse payment.
7622
7623         let chanmon_cfgs = create_chanmon_cfgs(2);
7624         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7625         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7626         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7627
7628         // Create some initial channels
7629         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
7630
7631         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
7632
7633         // Node 3 is expecting payment of 100_000 but receive 10_000,
7634         // fail htlc like we didn't know the preimage.
7635         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
7636         nodes[1].node.process_pending_htlc_forwards();
7637
7638         let events = nodes[1].node.get_and_clear_pending_msg_events();
7639         assert_eq!(events.len(), 1);
7640         let (update_fail_htlc, commitment_signed) = match events[0] {
7641                 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 } } => {
7642                         assert!(update_add_htlcs.is_empty());
7643                         assert!(update_fulfill_htlcs.is_empty());
7644                         assert_eq!(update_fail_htlcs.len(), 1);
7645                         assert!(update_fail_malformed_htlcs.is_empty());
7646                         assert!(update_fee.is_none());
7647                         (update_fail_htlcs[0].clone(), commitment_signed)
7648                 },
7649                 _ => panic!("Unexpected event"),
7650         };
7651         check_added_monitors!(nodes[1], 1);
7652
7653         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
7654         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
7655
7656         // 10_000 msat as u64, followed by a height of 99 as u32
7657         let mut expected_failure_data = byte_utils::be64_to_array(10_000).to_vec();
7658         expected_failure_data.extend_from_slice(&byte_utils::be32_to_array(99));
7659         expect_payment_failed!(nodes[0], payment_hash, true, 0x4000|15, &expected_failure_data[..]);
7660         nodes[1].node.get_and_clear_pending_events();
7661 }
7662
7663 #[test]
7664 fn test_announce_disable_channels() {
7665         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
7666         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
7667
7668         let chanmon_cfgs = create_chanmon_cfgs(2);
7669         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7670         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7671         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7672
7673         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7674         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7675         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
7676
7677         // Disconnect peers
7678         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7679         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7680
7681         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7682         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7683         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7684         assert_eq!(msg_events.len(), 3);
7685         for e in msg_events {
7686                 match e {
7687                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7688                                 let short_id = msg.contents.short_channel_id;
7689                                 // Check generated channel_update match list in PendingChannelUpdate
7690                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7691                                         panic!("Generated ChannelUpdate for wrong chan!");
7692                                 }
7693                         },
7694                         _ => panic!("Unexpected event"),
7695                 }
7696         }
7697         // Reconnect peers
7698         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7699         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7700         assert_eq!(reestablish_1.len(), 3);
7701         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7702         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7703         assert_eq!(reestablish_2.len(), 3);
7704
7705         // Reestablish chan_1
7706         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7707         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7708         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7709         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7710         // Reestablish chan_2
7711         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7712         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7713         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7714         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7715         // Reestablish chan_3
7716         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7717         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7718         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7719         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7720
7721         nodes[0].node.timer_chan_freshness_every_min();
7722         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7723 }
7724
7725 #[test]
7726 fn test_bump_penalty_txn_on_revoked_commitment() {
7727         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7728         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7729
7730         let chanmon_cfgs = create_chanmon_cfgs(2);
7731         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7732         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7733         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7734
7735         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7736         let logger = test_utils::TestLogger::new();
7737
7738
7739         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7740         let net_graph_msg_handler = &nodes[1].net_graph_msg_handler;
7741         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();
7742         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7743
7744         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7745         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7746         assert_eq!(revoked_txn[0].output.len(), 4);
7747         assert_eq!(revoked_txn[0].input.len(), 1);
7748         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7749         let revoked_txid = revoked_txn[0].txid();
7750
7751         let mut penalty_sum = 0;
7752         for outp in revoked_txn[0].output.iter() {
7753                 if outp.script_pubkey.is_v0_p2wsh() {
7754                         penalty_sum += outp.value;
7755                 }
7756         }
7757
7758         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7759         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
7760
7761         // Actually revoke tx by claiming a HTLC
7762         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7763         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7764         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7765         check_added_monitors!(nodes[1], 1);
7766
7767         // One or more justice tx should have been broadcast, check it
7768         let penalty_1;
7769         let feerate_1;
7770         {
7771                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7772                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7773                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7774                 assert_eq!(node_txn[0].output.len(), 1);
7775                 check_spends!(node_txn[0], revoked_txn[0]);
7776                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7777                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7778                 penalty_1 = node_txn[0].txid();
7779                 node_txn.clear();
7780         };
7781
7782         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7783         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
7784         let mut penalty_2 = penalty_1;
7785         let mut feerate_2 = 0;
7786         {
7787                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7788                 assert_eq!(node_txn.len(), 1);
7789                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7790                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7791                         assert_eq!(node_txn[0].output.len(), 1);
7792                         check_spends!(node_txn[0], revoked_txn[0]);
7793                         penalty_2 = node_txn[0].txid();
7794                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7795                         assert_ne!(penalty_2, penalty_1);
7796                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7797                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7798                         // Verify 25% bump heuristic
7799                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7800                         node_txn.clear();
7801                 }
7802         }
7803         assert_ne!(feerate_2, 0);
7804
7805         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7806         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
7807         let penalty_3;
7808         let mut feerate_3 = 0;
7809         {
7810                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7811                 assert_eq!(node_txn.len(), 1);
7812                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7813                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7814                         assert_eq!(node_txn[0].output.len(), 1);
7815                         check_spends!(node_txn[0], revoked_txn[0]);
7816                         penalty_3 = node_txn[0].txid();
7817                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7818                         assert_ne!(penalty_3, penalty_2);
7819                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7820                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7821                         // Verify 25% bump heuristic
7822                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7823                         node_txn.clear();
7824                 }
7825         }
7826         assert_ne!(feerate_3, 0);
7827
7828         nodes[1].node.get_and_clear_pending_events();
7829         nodes[1].node.get_and_clear_pending_msg_events();
7830 }
7831
7832 #[test]
7833 fn test_bump_penalty_txn_on_revoked_htlcs() {
7834         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7835         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7836
7837         let chanmon_cfgs = create_chanmon_cfgs(2);
7838         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7839         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7840         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7841
7842         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7843         // Lock HTLC in both directions
7844         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7845         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7846
7847         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7848         assert_eq!(revoked_local_txn[0].input.len(), 1);
7849         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7850
7851         // Revoke local commitment tx
7852         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7853
7854         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7855         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7856         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7857         check_closed_broadcast!(nodes[1], false);
7858         check_added_monitors!(nodes[1], 1);
7859
7860         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7861         assert_eq!(revoked_htlc_txn.len(), 4);
7862         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7863                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7864                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7865                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7866                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7867                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7868         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7869                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7870                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7871                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7872                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7873                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7874         }
7875
7876         // Broadcast set of revoked txn on A
7877         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
7878         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7879
7880         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7881         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);
7882         let first;
7883         let feerate_1;
7884         let penalty_txn;
7885         {
7886                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7887                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7888                 // Verify claim tx are spending revoked HTLC txn
7889                 assert_eq!(node_txn[3].input.len(), 2);
7890                 assert_eq!(node_txn[3].output.len(), 1);
7891                 check_spends!(node_txn[3], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7892                 first = node_txn[3].txid();
7893                 // Store both feerates for later comparison
7894                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[3].output[0].value;
7895                 feerate_1 = fee_1 * 1000 / node_txn[3].get_weight() as u64;
7896                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7897                 node_txn.clear();
7898         }
7899
7900         // Connect three more block to see if bumped penalty are issued for HTLC txn
7901         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7902         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7903         {
7904                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7905                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7906
7907                 check_spends!(node_txn[0], revoked_local_txn[0]);
7908                 check_spends!(node_txn[1], revoked_local_txn[0]);
7909
7910                 node_txn.clear();
7911         };
7912
7913         // Few more blocks to confirm penalty txn
7914         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
7915         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7916         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
7917         let node_txn = {
7918                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7919                 assert_eq!(node_txn.len(), 1);
7920
7921                 assert_eq!(node_txn[0].input.len(), 2);
7922                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7923                 // Verify bumped tx is different and 25% bump heuristic
7924                 assert_ne!(first, node_txn[0].txid());
7925                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7926                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7927                 assert!(feerate_2 * 100 > feerate_1 * 125);
7928                 let txn = vec![node_txn[0].clone()];
7929                 node_txn.clear();
7930                 txn
7931         };
7932         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7933         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7934         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
7935         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
7936         {
7937                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7938                 // We verify than no new transaction has been broadcast because previously
7939                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7940                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7941                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7942                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7943                 // up bumped justice generation.
7944                 assert_eq!(node_txn.len(), 0);
7945                 node_txn.clear();
7946         }
7947         check_closed_broadcast!(nodes[0], false);
7948         check_added_monitors!(nodes[0], 1);
7949 }
7950
7951 #[test]
7952 fn test_bump_penalty_txn_on_remote_commitment() {
7953         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7954         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7955
7956         // Create 2 HTLCs
7957         // Provide preimage for one
7958         // Check aggregation
7959
7960         let chanmon_cfgs = create_chanmon_cfgs(2);
7961         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7962         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7963         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7964
7965         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
7966         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7967         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7968
7969         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7970         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7971         assert_eq!(remote_txn[0].output.len(), 4);
7972         assert_eq!(remote_txn[0].input.len(), 1);
7973         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7974
7975         // Claim a HTLC without revocation (provide B monitor with preimage)
7976         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7977         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7978         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7979         check_added_monitors!(nodes[1], 2);
7980
7981         // One or more claim tx should have been broadcast, check it
7982         let timeout;
7983         let preimage;
7984         let feerate_timeout;
7985         let feerate_preimage;
7986         {
7987                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7988                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7989                 assert_eq!(node_txn[0].input.len(), 1);
7990                 assert_eq!(node_txn[1].input.len(), 1);
7991                 check_spends!(node_txn[0], remote_txn[0]);
7992                 check_spends!(node_txn[1], remote_txn[0]);
7993                 check_spends!(node_txn[2], chan.3);
7994                 check_spends!(node_txn[3], node_txn[2]);
7995                 check_spends!(node_txn[4], node_txn[2]);
7996                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7997                         timeout = node_txn[0].txid();
7998                         let index = node_txn[0].input[0].previous_output.vout;
7999                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8000                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
8001
8002                         preimage = node_txn[1].txid();
8003                         let index = node_txn[1].input[0].previous_output.vout;
8004                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8005                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
8006                 } else {
8007                         timeout = node_txn[1].txid();
8008                         let index = node_txn[1].input[0].previous_output.vout;
8009                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8010                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
8011
8012                         preimage = node_txn[0].txid();
8013                         let index = node_txn[0].input[0].previous_output.vout;
8014                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8015                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
8016                 }
8017                 node_txn.clear();
8018         };
8019         assert_ne!(feerate_timeout, 0);
8020         assert_ne!(feerate_preimage, 0);
8021
8022         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
8023         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
8024         {
8025                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8026                 assert_eq!(node_txn.len(), 2);
8027                 assert_eq!(node_txn[0].input.len(), 1);
8028                 assert_eq!(node_txn[1].input.len(), 1);
8029                 check_spends!(node_txn[0], remote_txn[0]);
8030                 check_spends!(node_txn[1], remote_txn[0]);
8031                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
8032                         let index = node_txn[0].input[0].previous_output.vout;
8033                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8034                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8035                         assert!(new_feerate * 100 > feerate_timeout * 125);
8036                         assert_ne!(timeout, node_txn[0].txid());
8037
8038                         let index = node_txn[1].input[0].previous_output.vout;
8039                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8040                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8041                         assert!(new_feerate * 100 > feerate_preimage * 125);
8042                         assert_ne!(preimage, node_txn[1].txid());
8043                 } else {
8044                         let index = node_txn[1].input[0].previous_output.vout;
8045                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
8046                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
8047                         assert!(new_feerate * 100 > feerate_timeout * 125);
8048                         assert_ne!(timeout, node_txn[1].txid());
8049
8050                         let index = node_txn[0].input[0].previous_output.vout;
8051                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
8052                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
8053                         assert!(new_feerate * 100 > feerate_preimage * 125);
8054                         assert_ne!(preimage, node_txn[0].txid());
8055                 }
8056                 node_txn.clear();
8057         }
8058
8059         nodes[1].node.get_and_clear_pending_events();
8060         nodes[1].node.get_and_clear_pending_msg_events();
8061 }
8062
8063 #[test]
8064 fn test_set_outpoints_partial_claiming() {
8065         // - remote party claim tx, new bump tx
8066         // - disconnect remote claiming tx, new bump
8067         // - disconnect tx, see no tx anymore
8068         let chanmon_cfgs = create_chanmon_cfgs(2);
8069         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8070         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8071         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8072
8073         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8074         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8075         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
8076
8077         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
8078         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
8079         assert_eq!(remote_txn.len(), 3);
8080         assert_eq!(remote_txn[0].output.len(), 4);
8081         assert_eq!(remote_txn[0].input.len(), 1);
8082         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
8083         check_spends!(remote_txn[1], remote_txn[0]);
8084         check_spends!(remote_txn[2], remote_txn[0]);
8085
8086         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
8087         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
8088         // Provide node A with both preimage
8089         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
8090         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
8091         check_added_monitors!(nodes[0], 2);
8092         nodes[0].node.get_and_clear_pending_events();
8093         nodes[0].node.get_and_clear_pending_msg_events();
8094
8095         // Connect blocks on node A commitment transaction
8096         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8097         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
8098         check_closed_broadcast!(nodes[0], false);
8099         check_added_monitors!(nodes[0], 1);
8100         // Verify node A broadcast tx claiming both HTLCs
8101         {
8102                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8103                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
8104                 assert_eq!(node_txn.len(), 4);
8105                 check_spends!(node_txn[0], remote_txn[0]);
8106                 check_spends!(node_txn[1], chan.3);
8107                 check_spends!(node_txn[2], node_txn[1]);
8108                 check_spends!(node_txn[3], node_txn[1]);
8109                 assert_eq!(node_txn[0].input.len(), 2);
8110                 node_txn.clear();
8111         }
8112
8113         // Connect blocks on node B
8114         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
8115         check_closed_broadcast!(nodes[1], false);
8116         check_added_monitors!(nodes[1], 1);
8117         // Verify node B broadcast 2 HTLC-timeout txn
8118         let partial_claim_tx = {
8119                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8120                 assert_eq!(node_txn.len(), 3);
8121                 check_spends!(node_txn[1], node_txn[0]);
8122                 check_spends!(node_txn[2], node_txn[0]);
8123                 assert_eq!(node_txn[1].input.len(), 1);
8124                 assert_eq!(node_txn[2].input.len(), 1);
8125                 node_txn[1].clone()
8126         };
8127
8128         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
8129         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8130         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
8131         {
8132                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8133                 assert_eq!(node_txn.len(), 1);
8134                 check_spends!(node_txn[0], remote_txn[0]);
8135                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
8136                 node_txn.clear();
8137         }
8138         nodes[0].node.get_and_clear_pending_msg_events();
8139
8140         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
8141         nodes[0].block_notifier.block_disconnected(&header, 102);
8142         {
8143                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8144                 assert_eq!(node_txn.len(), 1);
8145                 check_spends!(node_txn[0], remote_txn[0]);
8146                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
8147                 node_txn.clear();
8148         }
8149
8150         //// Disconnect one more block and then reconnect multiple no transaction should be generated
8151         nodes[0].block_notifier.block_disconnected(&header, 101);
8152         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
8153         {
8154                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8155                 assert_eq!(node_txn.len(), 0);
8156                 node_txn.clear();
8157         }
8158 }
8159
8160 #[test]
8161 fn test_counterparty_raa_skip_no_crash() {
8162         // Previously, if our counterparty sent two RAAs in a row without us having provided a
8163         // commitment transaction, we would have happily carried on and provided them the next
8164         // commitment transaction based on one RAA forward. This would probably eventually have led to
8165         // channel closure, but it would not have resulted in funds loss. Still, our
8166         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
8167         // check simply that the channel is closed in response to such an RAA, but don't check whether
8168         // we decide to punish our counterparty for revoking their funds (as we don't currently
8169         // implement that).
8170         let chanmon_cfgs = create_chanmon_cfgs(2);
8171         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8172         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8173         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8174         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).2;
8175
8176         let mut guard = nodes[0].node.channel_state.lock().unwrap();
8177         let local_keys = &guard.by_id.get_mut(&channel_id).unwrap().local_keys;
8178         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
8179         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
8180                 &SecretKey::from_slice(&local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
8181         let per_commitment_secret = local_keys.release_commitment_secret(INITIAL_COMMITMENT_NUMBER);
8182
8183         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
8184                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
8185         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
8186         check_added_monitors!(nodes[1], 1);
8187 }
8188
8189 #[test]
8190 fn test_bump_txn_sanitize_tracking_maps() {
8191         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
8192         // verify we clean then right after expiration of ANTI_REORG_DELAY.
8193
8194         let chanmon_cfgs = create_chanmon_cfgs(2);
8195         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8196         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8197         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8198
8199         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::known(), InitFeatures::known());
8200         // Lock HTLC in both directions
8201         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8202         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
8203
8204         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
8205         assert_eq!(revoked_local_txn[0].input.len(), 1);
8206         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8207
8208         // Revoke local commitment tx
8209         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
8210
8211         // Broadcast set of revoked txn on A
8212         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
8213         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
8214
8215         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8216         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
8217         check_closed_broadcast!(nodes[0], false);
8218         check_added_monitors!(nodes[0], 1);
8219         let penalty_txn = {
8220                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8221                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
8222                 check_spends!(node_txn[0], revoked_local_txn[0]);
8223                 check_spends!(node_txn[1], revoked_local_txn[0]);
8224                 check_spends!(node_txn[2], revoked_local_txn[0]);
8225                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
8226                 node_txn.clear();
8227                 penalty_txn
8228         };
8229         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8230         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
8231         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
8232         {
8233                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8234                 if let Some(monitor) = monitors.get(&OutPoint { txid: chan.3.txid(), index: 0 }) {
8235                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
8236                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
8237                 }
8238         }
8239 }
8240
8241 #[test]
8242 fn test_override_channel_config() {
8243         let chanmon_cfgs = create_chanmon_cfgs(2);
8244         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8245         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8246         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8247
8248         // Node0 initiates a channel to node1 using the override config.
8249         let mut override_config = UserConfig::default();
8250         override_config.own_channel_config.our_to_self_delay = 200;
8251
8252         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
8253
8254         // Assert the channel created by node0 is using the override config.
8255         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8256         assert_eq!(res.channel_flags, 0);
8257         assert_eq!(res.to_self_delay, 200);
8258 }
8259
8260 #[test]
8261 fn test_override_0msat_htlc_minimum() {
8262         let mut zero_config = UserConfig::default();
8263         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
8264         let chanmon_cfgs = create_chanmon_cfgs(2);
8265         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8266         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
8267         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8268
8269         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
8270         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
8271         assert_eq!(res.htlc_minimum_msat, 1);
8272
8273         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::known(), &res);
8274         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
8275         assert_eq!(res.htlc_minimum_msat, 1);
8276 }
8277
8278 #[test]
8279 fn test_simple_payment_secret() {
8280         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
8281         // features, however.
8282         let chanmon_cfgs = create_chanmon_cfgs(3);
8283         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
8284         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
8285         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
8286
8287         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8288         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::known(), InitFeatures::known());
8289         let logger = test_utils::TestLogger::new();
8290
8291         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8292         let payment_secret = PaymentSecret([0xdb; 32]);
8293         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8294         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();
8295         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
8296         // Claiming with all the correct values but the wrong secret should result in nothing...
8297         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
8298         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
8299         // ...but with the right secret we should be able to claim all the way back
8300         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
8301 }
8302
8303 #[test]
8304 fn test_simple_mpp() {
8305         // Simple test of sending a multi-path payment.
8306         let chanmon_cfgs = create_chanmon_cfgs(4);
8307         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
8308         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
8309         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
8310
8311         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8312         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8313         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8314         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::known(), InitFeatures::known()).0.contents.short_channel_id;
8315         let logger = test_utils::TestLogger::new();
8316
8317         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
8318         let payment_secret = PaymentSecret([0xdb; 32]);
8319         let net_graph_msg_handler = &nodes[0].net_graph_msg_handler;
8320         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();
8321         let path = route.paths[0].clone();
8322         route.paths.push(path);
8323         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
8324         route.paths[0][0].short_channel_id = chan_1_id;
8325         route.paths[0][1].short_channel_id = chan_3_id;
8326         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
8327         route.paths[1][0].short_channel_id = chan_2_id;
8328         route.paths[1][1].short_channel_id = chan_4_id;
8329         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
8330         // Claiming with all the correct values but the wrong secret should result in nothing...
8331         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
8332         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
8333         // ...but with the right secret we should be able to claim all the way back
8334         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
8335 }
8336
8337 #[test]
8338 fn test_update_err_monitor_lockdown() {
8339         // Our monitor will lock update of local commitment transaction if a broadcastion condition
8340         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
8341         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
8342         //
8343         // This scenario may happen in a watchtower setup, where watchtower process a block height
8344         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
8345         // commitment at same time.
8346
8347         let chanmon_cfgs = create_chanmon_cfgs(2);
8348         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
8349         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
8350         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
8351
8352         // Create some initial channel
8353         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::known(), InitFeatures::known());
8354         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
8355
8356         // Rebalance the network to generate htlc in the two directions
8357         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
8358
8359         // Route a HTLC from node 0 to node 1 (but don't settle)
8360         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
8361
8362         // Copy SimpleManyChannelMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
8363         let logger = test_utils::TestLogger::with_id(format!("node {}", 0));
8364         let chain_monitor = chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet);
8365         let watchtower = {
8366                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
8367                 let monitor = monitors.get(&outpoint).unwrap();
8368                 let mut w = test_utils::TestVecWriter(Vec::new());
8369                 monitor.write_for_disk(&mut w).unwrap();
8370                 let new_monitor = <(BlockHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
8371                                 &mut ::std::io::Cursor::new(&w.0)).unwrap().1;
8372                 assert!(new_monitor == *monitor);
8373                 let watchtower = test_utils::TestChannelMonitor::new(&chain_monitor, &chanmon_cfgs[0].tx_broadcaster, &logger, &chanmon_cfgs[0].fee_estimator);
8374                 assert!(watchtower.add_monitor(outpoint, new_monitor).is_ok());
8375                 watchtower
8376         };
8377         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8378         watchtower.simple_monitor.block_connected(&header, &[], 200);
8379
8380         // Try to update ChannelMonitor
8381         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
8382         check_added_monitors!(nodes[1], 1);
8383         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
8384         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
8385         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
8386         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
8387                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator, &node_cfgs[0].logger) {
8388                         if let Err(_) =  watchtower.simple_monitor.update_monitor(outpoint, update.clone()) {} else { assert!(false); }
8389                         if let Ok(_) = nodes[0].chan_monitor.update_monitor(outpoint, update) {} else { assert!(false); }
8390                 } else { assert!(false); }
8391         } else { assert!(false); };
8392         // Our local monitor is in-sync and hasn't processed yet timeout
8393         check_added_monitors!(nodes[0], 1);
8394         let events = nodes[0].node.get_and_clear_pending_events();
8395         assert_eq!(events.len(), 1);
8396 }