_ 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 ln::router::{Route, RouteHop};
  16 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  17 use ln::msgs;
  18 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  19 use util::enforcing_trait_impls::EnforcingChannelKeys;
  20 use util::test_utils;
  21 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  22 use util::errors::APIError;
  23 use util::ser::{Writeable, Writer, ReadableArgs};
  24 use util::config::UserConfig;
  25 use util::logger::Logger;
  26
  27 use bitcoin::util::hash::BitcoinHash;
  28 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
  29 use bitcoin::util::bip143;
  30 use bitcoin::util::address::Address;
  31 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  32 use bitcoin::blockdata::block::{Block, BlockHeader};
  33 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  34 use bitcoin::blockdata::script::{Builder, Script};
  35 use bitcoin::blockdata::opcodes;
  36 use bitcoin::blockdata::constants::genesis_block;
  37 use bitcoin::network::constants::Network;
  38
  39 use bitcoin_hashes::sha256::Hash as Sha256;
  40 use bitcoin_hashes::Hash;
  41
  42 use secp256k1::{Secp256k1, Message};
  43 use secp256k1::key::{PublicKey,SecretKey};
  44
  45 use std::collections::{BTreeSet, HashMap, HashSet};
  46 use std::default::Default;
  47 use std::sync::{Arc, Mutex};
  48 use std::sync::atomic::Ordering;
  49 use std::{mem, io};
  50
  51 use rand::{thread_rng, Rng};
  52
  53 use ln::functional_test_utils::*;
  54
  55 #[test]
  56 fn test_insane_channel_opens() {
  57         // Stand up a network of 2 nodes
  58         let chanmon_cfgs = create_chanmon_cfgs(2);
  59         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  60         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  61         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  62
  63         // Instantiate channel parameters where we push the maximum msats given our
  64         // funding satoshis
  65         let channel_value_sat = 31337; // same as funding satoshis
  66         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_our_channel_reserve_satoshis(channel_value_sat);
  67         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  68
  69         // Have node0 initiate a channel to node1 with aforementioned parameters
  70         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  71
  72         // Extract the channel open message from node0 to node1
  73         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  74
  75         // Test helper that asserts we get the correct error string given a mutator
  76         // that supposedly makes the channel open message insane
  77         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  78                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &message_mutator(open_channel_message.clone()));
  79                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  80                 assert_eq!(msg_events.len(), 1);
  81                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  82                         match action {
  83                                 &ErrorAction::SendErrorMessage { .. } => {
  84                                         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), expected_error_str.to_string(), 1);
  85                                 },
  86                                 _ => panic!("unexpected event!"),
  87                         }
  88                 } else { assert!(false); }
  89         };
  90
  91         use ln::channel::MAX_FUNDING_SATOSHIS;
  92         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  93
  94         // Test all mutations that would make the channel open message insane
  95         insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
  96
  97         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
  98
  99         insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
 100
 101         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 102
 103         insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 104
 105         insane_open_helper("Minimum htlc value is full channel value", |mut msg| { msg.htlc_minimum_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000; msg });
 106
 107         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 });
 108
 109         insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 110
 111         insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 112 }
 113
 114 #[test]
 115 fn test_async_inbound_update_fee() {
 116         let chanmon_cfgs = create_chanmon_cfgs(2);
 117         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 118         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 119         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 120         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 121         let channel_id = chan.2;
 122
 123         // balancing
 124         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 125
 126         // A                                        B
 127         // update_fee                            ->
 128         // send (1) commitment_signed            -.
 129         //                                       <- update_add_htlc/commitment_signed
 130         // send (2) RAA (awaiting remote revoke) -.
 131         // (1) commitment_signed is delivered    ->
 132         //                                       .- send (3) RAA (awaiting remote revoke)
 133         // (2) RAA is delivered                  ->
 134         //                                       .- send (4) commitment_signed
 135         //                                       <- (3) RAA is delivered
 136         // send (5) commitment_signed            -.
 137         //                                       <- (4) commitment_signed is delivered
 138         // send (6) RAA                          -.
 139         // (5) commitment_signed is delivered    ->
 140         //                                       <- RAA
 141         // (6) RAA is delivered                  ->
 142
 143         // First nodes[0] generates an update_fee
 144         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 145         check_added_monitors!(nodes[0], 1);
 146
 147         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 148         assert_eq!(events_0.len(), 1);
 149         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 150                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 151                         (update_fee.as_ref(), commitment_signed)
 152                 },
 153                 _ => panic!("Unexpected event"),
 154         };
 155
 156         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 157
 158         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 159         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 160         nodes[1].node.send_payment(&nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash, &None).unwrap();
 161         check_added_monitors!(nodes[1], 1);
 162
 163         let payment_event = {
 164                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 165                 assert_eq!(events_1.len(), 1);
 166                 SendEvent::from_event(events_1.remove(0))
 167         };
 168         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 169         assert_eq!(payment_event.msgs.len(), 1);
 170
 171         // ...now when the messages get delivered everyone should be happy
 172         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 173         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 174         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 175         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 176         check_added_monitors!(nodes[0], 1);
 177
 178         // deliver(1), generate (3):
 179         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 180         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 181         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 182         check_added_monitors!(nodes[1], 1);
 183
 184         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 185         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 186         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 187         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 188         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 189         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 190         assert!(bs_update.update_fee.is_none()); // (4)
 191         check_added_monitors!(nodes[1], 1);
 192
 193         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 194         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 195         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 196         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 197         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 198         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 199         assert!(as_update.update_fee.is_none()); // (5)
 200         check_added_monitors!(nodes[0], 1);
 201
 202         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 203         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 204         // only (6) so get_event_msg's assert(len == 1) passes
 205         check_added_monitors!(nodes[0], 1);
 206
 207         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 208         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 209         check_added_monitors!(nodes[1], 1);
 210
 211         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 212         check_added_monitors!(nodes[0], 1);
 213
 214         let events_2 = nodes[0].node.get_and_clear_pending_events();
 215         assert_eq!(events_2.len(), 1);
 216         match events_2[0] {
 217                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 218                 _ => panic!("Unexpected event"),
 219         }
 220
 221         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 222         check_added_monitors!(nodes[1], 1);
 223 }
 224
 225 #[test]
 226 fn test_update_fee_unordered_raa() {
 227         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 228         // crash in an earlier version of the update_fee patch)
 229         let chanmon_cfgs = create_chanmon_cfgs(2);
 230         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 231         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 232         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 233         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 234         let channel_id = chan.2;
 235
 236         // balancing
 237         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 238
 239         // First nodes[0] generates an update_fee
 240         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 241         check_added_monitors!(nodes[0], 1);
 242
 243         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 244         assert_eq!(events_0.len(), 1);
 245         let update_msg = match events_0[0] { // (1)
 246                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 247                         update_fee.as_ref()
 248                 },
 249                 _ => panic!("Unexpected event"),
 250         };
 251
 252         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 253
 254         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 255         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 256         nodes[1].node.send_payment(&nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash, &None).unwrap();
 257         check_added_monitors!(nodes[1], 1);
 258
 259         let payment_event = {
 260                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 261                 assert_eq!(events_1.len(), 1);
 262                 SendEvent::from_event(events_1.remove(0))
 263         };
 264         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 265         assert_eq!(payment_event.msgs.len(), 1);
 266
 267         // ...now when the messages get delivered everyone should be happy
 268         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 269         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 270         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 271         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 272         check_added_monitors!(nodes[0], 1);
 273
 274         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 275         check_added_monitors!(nodes[1], 1);
 276
 277         // We can't continue, sadly, because our (1) now has a bogus signature
 278 }
 279
 280 #[test]
 281 fn test_multi_flight_update_fee() {
 282         let chanmon_cfgs = create_chanmon_cfgs(2);
 283         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 284         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 285         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 286         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 287         let channel_id = chan.2;
 288
 289         // A                                        B
 290         // update_fee/commitment_signed          ->
 291         //                                       .- send (1) RAA and (2) commitment_signed
 292         // update_fee (never committed)          ->
 293         // (3) update_fee                        ->
 294         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 295         // don't track which updates correspond to which revoke_and_ack responses so we're in
 296         // AwaitingRAA mode and will not generate the update_fee yet.
 297         //                                       <- (1) RAA delivered
 298         // (3) is generated and send (4) CS      -.
 299         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 300         // know the per_commitment_point to use for it.
 301         //                                       <- (2) commitment_signed delivered
 302         // revoke_and_ack                        ->
 303         //                                          B should send no response here
 304         // (4) commitment_signed delivered       ->
 305         //                                       <- RAA/commitment_signed delivered
 306         // revoke_and_ack                        ->
 307
 308         // First nodes[0] generates an update_fee
 309         let initial_feerate = get_feerate!(nodes[0], channel_id);
 310         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 311         check_added_monitors!(nodes[0], 1);
 312
 313         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 314         assert_eq!(events_0.len(), 1);
 315         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 316                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 317                         (update_fee.as_ref().unwrap(), commitment_signed)
 318                 },
 319                 _ => panic!("Unexpected event"),
 320         };
 321
 322         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 323         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 324         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 325         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 326         check_added_monitors!(nodes[1], 1);
 327
 328         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 329         // transaction:
 330         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 331         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 332         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 333
 334         // Create the (3) update_fee message that nodes[0] will generate before it does...
 335         let mut update_msg_2 = msgs::UpdateFee {
 336                 channel_id: update_msg_1.channel_id.clone(),
 337                 feerate_per_kw: (initial_feerate + 30) as u32,
 338         };
 339
 340         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 341
 342         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 343         // Deliver (3)
 344         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 345
 346         // Deliver (1), generating (3) and (4)
 347         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 348         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 349         check_added_monitors!(nodes[0], 1);
 350         assert!(as_second_update.update_add_htlcs.is_empty());
 351         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 352         assert!(as_second_update.update_fail_htlcs.is_empty());
 353         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 354         // Check that the update_fee newly generated matches what we delivered:
 355         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 356         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 357
 358         // Deliver (2) commitment_signed
 359         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 360         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 361         check_added_monitors!(nodes[0], 1);
 362         // No commitment_signed so get_event_msg's assert(len == 1) passes
 363
 364         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 365         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 366         check_added_monitors!(nodes[1], 1);
 367
 368         // Delever (4)
 369         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 370         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 371         check_added_monitors!(nodes[1], 1);
 372
 373         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 374         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 375         check_added_monitors!(nodes[0], 1);
 376
 377         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 378         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 379         // No commitment_signed so get_event_msg's assert(len == 1) passes
 380         check_added_monitors!(nodes[0], 1);
 381
 382         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 383         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 384         check_added_monitors!(nodes[1], 1);
 385 }
 386
 387 #[test]
 388 fn test_1_conf_open() {
 389         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 390         // tests that we properly send one in that case.
 391         let mut alice_config = UserConfig::default();
 392         alice_config.own_channel_config.minimum_depth = 1;
 393         alice_config.channel_options.announced_channel = true;
 394         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 395         let mut bob_config = UserConfig::default();
 396         bob_config.own_channel_config.minimum_depth = 1;
 397         bob_config.channel_options.announced_channel = true;
 398         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 399         let chanmon_cfgs = create_chanmon_cfgs(2);
 400         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 401         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 402         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 403
 404         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
 405         assert!(nodes[0].chain_monitor.does_match_tx(&tx));
 406         assert!(nodes[1].chain_monitor.does_match_tx(&tx));
 407
 408         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 409         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
 410         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()));
 411
 412         nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
 413         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 414         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 415
 416         for node in nodes {
 417                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
 418                 node.router.handle_channel_update(&as_update).unwrap();
 419                 node.router.handle_channel_update(&bs_update).unwrap();
 420         }
 421 }
 422
 423 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 424         // Previously, we had issues deserializing channels when we hadn't connected the first block
 425         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 426         // serialization round-trips and simply do steps towards opening a channel and then drop the
 427         // Node objects.
 428
 429         let chanmon_cfgs = create_chanmon_cfgs(2);
 430         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 431         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 432         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 433
 434         if steps & 0b1000_0000 != 0{
 435                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 436                 nodes[0].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 437                 nodes[1].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 438         }
 439
 440         if steps & 0x0f == 0 { return; }
 441         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 442         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 443
 444         if steps & 0x0f == 1 { return; }
 445         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &open_channel);
 446         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 447
 448         if steps & 0x0f == 2 { return; }
 449         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
 450
 451         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 452
 453         if steps & 0x0f == 3 { return; }
 454         nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 455         check_added_monitors!(nodes[0], 0);
 456         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 457
 458         if steps & 0x0f == 4 { return; }
 459         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 460         {
 461                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
 462                 assert_eq!(added_monitors.len(), 1);
 463                 assert_eq!(added_monitors[0].0, funding_output);
 464                 added_monitors.clear();
 465         }
 466         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 467
 468         if steps & 0x0f == 5 { return; }
 469         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 470         {
 471                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 472                 assert_eq!(added_monitors.len(), 1);
 473                 assert_eq!(added_monitors[0].0, funding_output);
 474                 added_monitors.clear();
 475         }
 476
 477         let events_4 = nodes[0].node.get_and_clear_pending_events();
 478         assert_eq!(events_4.len(), 1);
 479         match events_4[0] {
 480                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 481                         assert_eq!(user_channel_id, 42);
 482                         assert_eq!(*funding_txo, funding_output);
 483                 },
 484                 _ => panic!("Unexpected event"),
 485         };
 486
 487         if steps & 0x0f == 6 { return; }
 488         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 489
 490         if steps & 0x0f == 7 { return; }
 491         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
 492         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 493 }
 494
 495 #[test]
 496 fn test_sanity_on_in_flight_opens() {
 497         do_test_sanity_on_in_flight_opens(0);
 498         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 499         do_test_sanity_on_in_flight_opens(1);
 500         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 501         do_test_sanity_on_in_flight_opens(2);
 502         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 503         do_test_sanity_on_in_flight_opens(3);
 504         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 505         do_test_sanity_on_in_flight_opens(4);
 506         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 507         do_test_sanity_on_in_flight_opens(5);
 508         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 509         do_test_sanity_on_in_flight_opens(6);
 510         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 511         do_test_sanity_on_in_flight_opens(7);
 512         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 513         do_test_sanity_on_in_flight_opens(8);
 514         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 515 }
 516
 517 #[test]
 518 fn test_update_fee_vanilla() {
 519         let chanmon_cfgs = create_chanmon_cfgs(2);
 520         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 521         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 522         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 523         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 524         let channel_id = chan.2;
 525
 526         let feerate = get_feerate!(nodes[0], channel_id);
 527         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 528         check_added_monitors!(nodes[0], 1);
 529
 530         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 531         assert_eq!(events_0.len(), 1);
 532         let (update_msg, commitment_signed) = match events_0[0] {
 533                         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 } } => {
 534                         (update_fee.as_ref(), commitment_signed)
 535                 },
 536                 _ => panic!("Unexpected event"),
 537         };
 538         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 539
 540         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 541         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 542         check_added_monitors!(nodes[1], 1);
 543
 544         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 545         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 546         check_added_monitors!(nodes[0], 1);
 547
 548         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 549         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 550         // No commitment_signed so get_event_msg's assert(len == 1) passes
 551         check_added_monitors!(nodes[0], 1);
 552
 553         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 554         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 555         check_added_monitors!(nodes[1], 1);
 556 }
 557
 558 #[test]
 559 fn test_update_fee_that_funder_cannot_afford() {
 560         let chanmon_cfgs = create_chanmon_cfgs(2);
 561         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 562         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 563         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 564         let channel_value = 1888;
 565         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::supported(), InitFeatures::supported());
 566         let channel_id = chan.2;
 567
 568         let feerate = 260;
 569         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 570         check_added_monitors!(nodes[0], 1);
 571         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 572
 573         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 574
 575         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 576
 577         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 578         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 579         {
 580                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 581
 582                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 583                 let num_htlcs = commitment_tx.output.len() - 2;
 584                 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 585                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 586                 actual_fee = channel_value - actual_fee;
 587                 assert_eq!(total_fee, actual_fee);
 588         }
 589
 590         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 591         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 592         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 593         check_added_monitors!(nodes[0], 1);
 594
 595         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 596
 597         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 598
 599         //While producing the commitment_signed response after handling a received update_fee request the
 600         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 601         //Should produce and error.
 602         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 603         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 604         check_added_monitors!(nodes[1], 1);
 605         check_closed_broadcast!(nodes[1], true);
 606 }
 607
 608 #[test]
 609 fn test_update_fee_with_fundee_update_add_htlc() {
 610         let chanmon_cfgs = create_chanmon_cfgs(2);
 611         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 612         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 613         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 614         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 615         let channel_id = chan.2;
 616
 617         // balancing
 618         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 619
 620         let feerate = get_feerate!(nodes[0], channel_id);
 621         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 622         check_added_monitors!(nodes[0], 1);
 623
 624         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 625         assert_eq!(events_0.len(), 1);
 626         let (update_msg, commitment_signed) = match events_0[0] {
 627                         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 } } => {
 628                         (update_fee.as_ref(), commitment_signed)
 629                 },
 630                 _ => panic!("Unexpected event"),
 631         };
 632         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 633         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 634         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 635         check_added_monitors!(nodes[1], 1);
 636
 637         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
 638
 639         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 640
 641         // nothing happens since node[1] is in AwaitingRemoteRevoke
 642         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
 643         {
 644                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 645                 assert_eq!(added_monitors.len(), 0);
 646                 added_monitors.clear();
 647         }
 648         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 649         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 650         // node[1] has nothing to do
 651
 652         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 653         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 654         check_added_monitors!(nodes[0], 1);
 655
 656         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 657         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 658         // No commitment_signed so get_event_msg's assert(len == 1) passes
 659         check_added_monitors!(nodes[0], 1);
 660         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 661         check_added_monitors!(nodes[1], 1);
 662         // AwaitingRemoteRevoke ends here
 663
 664         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 665         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 666         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 667         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 668         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 669         assert_eq!(commitment_update.update_fee.is_none(), true);
 670
 671         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 672         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 673         check_added_monitors!(nodes[0], 1);
 674         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 675
 676         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 677         check_added_monitors!(nodes[1], 1);
 678         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 679
 680         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 681         check_added_monitors!(nodes[1], 1);
 682         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 683         // No commitment_signed so get_event_msg's assert(len == 1) passes
 684
 685         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 686         check_added_monitors!(nodes[0], 1);
 687         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 688
 689         expect_pending_htlcs_forwardable!(nodes[0]);
 690
 691         let events = nodes[0].node.get_and_clear_pending_events();
 692         assert_eq!(events.len(), 1);
 693         match events[0] {
 694                 Event::PaymentReceived { .. } => { },
 695                 _ => panic!("Unexpected event"),
 696         };
 697
 698         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 699
 700         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 701         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 702         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 703 }
 704
 705 #[test]
 706 fn test_update_fee() {
 707         let chanmon_cfgs = create_chanmon_cfgs(2);
 708         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 709         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 710         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 711         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 712         let channel_id = chan.2;
 713
 714         // A                                        B
 715         // (1) update_fee/commitment_signed      ->
 716         //                                       <- (2) revoke_and_ack
 717         //                                       .- send (3) commitment_signed
 718         // (4) update_fee/commitment_signed      ->
 719         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 720         //                                       <- (3) commitment_signed delivered
 721         // send (6) revoke_and_ack               -.
 722         //                                       <- (5) deliver revoke_and_ack
 723         // (6) deliver revoke_and_ack            ->
 724         //                                       .- send (7) commitment_signed in response to (4)
 725         //                                       <- (7) deliver commitment_signed
 726         // revoke_and_ack                        ->
 727
 728         // Create and deliver (1)...
 729         let feerate = get_feerate!(nodes[0], channel_id);
 730         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 731         check_added_monitors!(nodes[0], 1);
 732
 733         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 734         assert_eq!(events_0.len(), 1);
 735         let (update_msg, commitment_signed) = match events_0[0] {
 736                         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 } } => {
 737                         (update_fee.as_ref(), commitment_signed)
 738                 },
 739                 _ => panic!("Unexpected event"),
 740         };
 741         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 742
 743         // Generate (2) and (3):
 744         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 745         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 746         check_added_monitors!(nodes[1], 1);
 747
 748         // Deliver (2):
 749         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 750         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 751         check_added_monitors!(nodes[0], 1);
 752
 753         // Create and deliver (4)...
 754         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 755         check_added_monitors!(nodes[0], 1);
 756         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 757         assert_eq!(events_0.len(), 1);
 758         let (update_msg, commitment_signed) = match events_0[0] {
 759                         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 } } => {
 760                         (update_fee.as_ref(), commitment_signed)
 761                 },
 762                 _ => panic!("Unexpected event"),
 763         };
 764
 765         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 766         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 767         check_added_monitors!(nodes[1], 1);
 768         // ... creating (5)
 769         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 770         // No commitment_signed so get_event_msg's assert(len == 1) passes
 771
 772         // Handle (3), creating (6):
 773         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 774         check_added_monitors!(nodes[0], 1);
 775         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 776         // No commitment_signed so get_event_msg's assert(len == 1) passes
 777
 778         // Deliver (5):
 779         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 780         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 781         check_added_monitors!(nodes[0], 1);
 782
 783         // Deliver (6), creating (7):
 784         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 785         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 786         assert!(commitment_update.update_add_htlcs.is_empty());
 787         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 788         assert!(commitment_update.update_fail_htlcs.is_empty());
 789         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 790         assert!(commitment_update.update_fee.is_none());
 791         check_added_monitors!(nodes[1], 1);
 792
 793         // Deliver (7)
 794         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 795         check_added_monitors!(nodes[0], 1);
 796         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 797         // No commitment_signed so get_event_msg's assert(len == 1) passes
 798
 799         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 800         check_added_monitors!(nodes[1], 1);
 801         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 802
 803         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 804         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 805         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 806 }
 807
 808 #[test]
 809 fn pre_funding_lock_shutdown_test() {
 810         // Test sending a shutdown prior to funding_locked after funding generation
 811         let chanmon_cfgs = create_chanmon_cfgs(2);
 812         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 813         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 814         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 815         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::supported(), InitFeatures::supported());
 816         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 817         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 818         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 819
 820         nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
 821         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 822         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 823         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 824         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 825
 826         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 827         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 828         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 829         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 830         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 831         assert!(node_0_none.is_none());
 832
 833         assert!(nodes[0].node.list_channels().is_empty());
 834         assert!(nodes[1].node.list_channels().is_empty());
 835 }
 836
 837 #[test]
 838 fn updates_shutdown_wait() {
 839         // Test sending a shutdown with outstanding updates pending
 840         let chanmon_cfgs = create_chanmon_cfgs(3);
 841         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 842         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 843         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 844         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 845         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 846         let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 847         let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 848
 849         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 850
 851         nodes[0].node.close_channel(&chan_1.2).unwrap();
 852         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 853         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 854         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 855         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 856
 857         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 858         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 859
 860         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 861         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 862         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 863
 864         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 865         check_added_monitors!(nodes[2], 1);
 866         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 867         assert!(updates.update_add_htlcs.is_empty());
 868         assert!(updates.update_fail_htlcs.is_empty());
 869         assert!(updates.update_fail_malformed_htlcs.is_empty());
 870         assert!(updates.update_fee.is_none());
 871         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 872         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 873         check_added_monitors!(nodes[1], 1);
 874         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 875         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 876
 877         assert!(updates_2.update_add_htlcs.is_empty());
 878         assert!(updates_2.update_fail_htlcs.is_empty());
 879         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 880         assert!(updates_2.update_fee.is_none());
 881         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 882         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 883         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 884
 885         let events = nodes[0].node.get_and_clear_pending_events();
 886         assert_eq!(events.len(), 1);
 887         match events[0] {
 888                 Event::PaymentSent { ref payment_preimage } => {
 889                         assert_eq!(our_payment_preimage, *payment_preimage);
 890                 },
 891                 _ => panic!("Unexpected event"),
 892         }
 893
 894         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 895         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 896         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 897         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 898         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 899         assert!(node_0_none.is_none());
 900
 901         assert!(nodes[0].node.list_channels().is_empty());
 902
 903         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 904         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 905         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 906         assert!(nodes[1].node.list_channels().is_empty());
 907         assert!(nodes[2].node.list_channels().is_empty());
 908 }
 909
 910 #[test]
 911 fn htlc_fail_async_shutdown() {
 912         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 913         let chanmon_cfgs = create_chanmon_cfgs(3);
 914         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 915         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 916         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 917         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 918         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 919
 920         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 921         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 922         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 923         check_added_monitors!(nodes[0], 1);
 924         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 925         assert_eq!(updates.update_add_htlcs.len(), 1);
 926         assert!(updates.update_fulfill_htlcs.is_empty());
 927         assert!(updates.update_fail_htlcs.is_empty());
 928         assert!(updates.update_fail_malformed_htlcs.is_empty());
 929         assert!(updates.update_fee.is_none());
 930
 931         nodes[1].node.close_channel(&chan_1.2).unwrap();
 932         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 933         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 934         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 935
 936         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 937         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 938         check_added_monitors!(nodes[1], 1);
 939         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 940         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 941
 942         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 943         assert!(updates_2.update_add_htlcs.is_empty());
 944         assert!(updates_2.update_fulfill_htlcs.is_empty());
 945         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 946         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 947         assert!(updates_2.update_fee.is_none());
 948
 949         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 950         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 951
 952         let events = nodes[0].node.get_and_clear_pending_events();
 953         assert_eq!(events.len(), 1);
 954         match events[0] {
 955                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
 956                         assert_eq!(our_payment_hash, *payment_hash);
 957                         assert!(!rejected_by_dest);
 958                 },
 959                 _ => panic!("Unexpected event"),
 960         }
 961
 962         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 963         assert_eq!(msg_events.len(), 2);
 964         let node_0_closing_signed = match msg_events[0] {
 965                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 966                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 967                         (*msg).clone()
 968                 },
 969                 _ => panic!("Unexpected event"),
 970         };
 971         match msg_events[1] {
 972                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 973                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 974                 },
 975                 _ => panic!("Unexpected event"),
 976         }
 977
 978         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 979         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 980         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 981         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 982         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 983         assert!(node_0_none.is_none());
 984
 985         assert!(nodes[0].node.list_channels().is_empty());
 986
 987         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 988         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 989         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 990         assert!(nodes[1].node.list_channels().is_empty());
 991         assert!(nodes[2].node.list_channels().is_empty());
 992 }
 993
 994 fn do_test_shutdown_rebroadcast(recv_count: u8) {
 995         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
 996         // messages delivered prior to disconnect
 997         let chanmon_cfgs = create_chanmon_cfgs(3);
 998         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 999         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1000         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1001         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1002         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1003
1004         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1005
1006         nodes[1].node.close_channel(&chan_1.2).unwrap();
1007         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1008         if recv_count > 0 {
1009                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1010                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1011                 if recv_count > 1 {
1012                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1013                 }
1014         }
1015
1016         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1017         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1018
1019         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1020         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1021         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1022         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1023
1024         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1025         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1026         assert!(node_1_shutdown == node_1_2nd_shutdown);
1027
1028         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1029         let node_0_2nd_shutdown = if recv_count > 0 {
1030                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1031                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1032                 node_0_2nd_shutdown
1033         } else {
1034                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1035                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1036                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1037         };
1038         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1039
1040         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1041         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1042
1043         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1044         check_added_monitors!(nodes[2], 1);
1045         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1046         assert!(updates.update_add_htlcs.is_empty());
1047         assert!(updates.update_fail_htlcs.is_empty());
1048         assert!(updates.update_fail_malformed_htlcs.is_empty());
1049         assert!(updates.update_fee.is_none());
1050         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1051         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1052         check_added_monitors!(nodes[1], 1);
1053         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1054         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1055
1056         assert!(updates_2.update_add_htlcs.is_empty());
1057         assert!(updates_2.update_fail_htlcs.is_empty());
1058         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1059         assert!(updates_2.update_fee.is_none());
1060         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1061         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1062         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1063
1064         let events = nodes[0].node.get_and_clear_pending_events();
1065         assert_eq!(events.len(), 1);
1066         match events[0] {
1067                 Event::PaymentSent { ref payment_preimage } => {
1068                         assert_eq!(our_payment_preimage, *payment_preimage);
1069                 },
1070                 _ => panic!("Unexpected event"),
1071         }
1072
1073         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1074         if recv_count > 0 {
1075                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1076                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1077                 assert!(node_1_closing_signed.is_some());
1078         }
1079
1080         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1081         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1082
1083         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1084         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1085         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1086         if recv_count == 0 {
1087                 // If all closing_signeds weren't delivered we can just resume where we left off...
1088                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1089
1090                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1091                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1092                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1093
1094                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1095                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1096                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1097
1098                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1099                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1100
1101                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1102                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1103                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1104
1105                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1106                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1107                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1108                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1109                 assert!(node_0_none.is_none());
1110         } else {
1111                 // If one node, however, received + responded with an identical closing_signed we end
1112                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1113                 // There isn't really anything better we can do simply, but in the future we might
1114                 // explore storing a set of recently-closed channels that got disconnected during
1115                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1116                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1117                 // transaction.
1118                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1119
1120                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1121                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1122                 assert_eq!(msg_events.len(), 1);
1123                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1124                         match action {
1125                                 &ErrorAction::SendErrorMessage { ref msg } => {
1126                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1127                                         assert_eq!(msg.channel_id, chan_1.2);
1128                                 },
1129                                 _ => panic!("Unexpected event!"),
1130                         }
1131                 } else { panic!("Needed SendErrorMessage close"); }
1132
1133                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1134                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1135                 // closing_signed so we do it ourselves
1136                 check_closed_broadcast!(nodes[0], false);
1137                 check_added_monitors!(nodes[0], 1);
1138         }
1139
1140         assert!(nodes[0].node.list_channels().is_empty());
1141
1142         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1143         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1144         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1145         assert!(nodes[1].node.list_channels().is_empty());
1146         assert!(nodes[2].node.list_channels().is_empty());
1147 }
1148
1149 #[test]
1150 fn test_shutdown_rebroadcast() {
1151         do_test_shutdown_rebroadcast(0);
1152         do_test_shutdown_rebroadcast(1);
1153         do_test_shutdown_rebroadcast(2);
1154 }
1155
1156 #[test]
1157 fn fake_network_test() {
1158         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1159         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1160         let chanmon_cfgs = create_chanmon_cfgs(4);
1161         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1162         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1163         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1164
1165         // Create some initial channels
1166         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1167         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1168         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1169
1170         // Rebalance the network a bit by relaying one payment through all the channels...
1171         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1172         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1173         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1174         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1175
1176         // Send some more payments
1177         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1178         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1179         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1180
1181         // Test failure packets
1182         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1183         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1184
1185         // Add a new channel that skips 3
1186         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1187
1188         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1189         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1190         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1191         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1192         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1193         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1194         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1195
1196         // Do some rebalance loop payments, simultaneously
1197         let mut hops = Vec::with_capacity(3);
1198         hops.push(RouteHop {
1199                 pubkey: nodes[2].node.get_our_node_id(),
1200                 node_features: NodeFeatures::empty(),
1201                 short_channel_id: chan_2.0.contents.short_channel_id,
1202                 channel_features: ChannelFeatures::empty(),
1203                 fee_msat: 0,
1204                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1205         });
1206         hops.push(RouteHop {
1207                 pubkey: nodes[3].node.get_our_node_id(),
1208                 node_features: NodeFeatures::empty(),
1209                 short_channel_id: chan_3.0.contents.short_channel_id,
1210                 channel_features: ChannelFeatures::empty(),
1211                 fee_msat: 0,
1212                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1213         });
1214         hops.push(RouteHop {
1215                 pubkey: nodes[1].node.get_our_node_id(),
1216                 node_features: NodeFeatures::empty(),
1217                 short_channel_id: chan_4.0.contents.short_channel_id,
1218                 channel_features: ChannelFeatures::empty(),
1219                 fee_msat: 1000000,
1220                 cltv_expiry_delta: TEST_FINAL_CLTV,
1221         });
1222         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;
1223         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;
1224         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1225
1226         let mut hops = Vec::with_capacity(3);
1227         hops.push(RouteHop {
1228                 pubkey: nodes[3].node.get_our_node_id(),
1229                 node_features: NodeFeatures::empty(),
1230                 short_channel_id: chan_4.0.contents.short_channel_id,
1231                 channel_features: ChannelFeatures::empty(),
1232                 fee_msat: 0,
1233                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1234         });
1235         hops.push(RouteHop {
1236                 pubkey: nodes[2].node.get_our_node_id(),
1237                 node_features: NodeFeatures::empty(),
1238                 short_channel_id: chan_3.0.contents.short_channel_id,
1239                 channel_features: ChannelFeatures::empty(),
1240                 fee_msat: 0,
1241                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1242         });
1243         hops.push(RouteHop {
1244                 pubkey: nodes[1].node.get_our_node_id(),
1245                 node_features: NodeFeatures::empty(),
1246                 short_channel_id: chan_2.0.contents.short_channel_id,
1247                 channel_features: ChannelFeatures::empty(),
1248                 fee_msat: 1000000,
1249                 cltv_expiry_delta: TEST_FINAL_CLTV,
1250         });
1251         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;
1252         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;
1253         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1254
1255         // Claim the rebalances...
1256         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1257         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1258
1259         // Add a duplicate new channel from 2 to 4
1260         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1261
1262         // Send some payments across both channels
1263         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1264         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1265         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1266
1267
1268         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1269         let events = nodes[0].node.get_and_clear_pending_msg_events();
1270         assert_eq!(events.len(), 0);
1271         nodes[0].logger.assert_log("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);
1272
1273         //TODO: Test that routes work again here as we've been notified that the channel is full
1274
1275         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1276         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1277         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1278
1279         // Close down the channels...
1280         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1281         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1282         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1283         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1284         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1285 }
1286
1287 #[test]
1288 fn holding_cell_htlc_counting() {
1289         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1290         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1291         // commitment dance rounds.
1292         let chanmon_cfgs = create_chanmon_cfgs(3);
1293         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1294         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1295         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1296         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1297         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1298
1299         let mut payments = Vec::new();
1300         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1301                 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1302                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1303                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1304                 payments.push((payment_preimage, payment_hash));
1305         }
1306         check_added_monitors!(nodes[1], 1);
1307
1308         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1309         assert_eq!(events.len(), 1);
1310         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1311         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1312
1313         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1314         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1315         // another HTLC.
1316         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1317         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1318         unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { err },
1319                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
1320         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1321         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1322
1323         // This should also be true if we try to forward a payment.
1324         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1325         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1326         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1327         check_added_monitors!(nodes[0], 1);
1328
1329         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1330         assert_eq!(events.len(), 1);
1331         let payment_event = SendEvent::from_event(events.pop().unwrap());
1332         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1333
1334         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1335         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1336         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1337         // fails), the second will process the resulting failure and fail the HTLC backward.
1338         expect_pending_htlcs_forwardable!(nodes[1]);
1339         expect_pending_htlcs_forwardable!(nodes[1]);
1340         check_added_monitors!(nodes[1], 1);
1341
1342         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1343         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1344         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1345
1346         let events = nodes[0].node.get_and_clear_pending_msg_events();
1347         assert_eq!(events.len(), 1);
1348         match events[0] {
1349                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1350                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1351                 },
1352                 _ => panic!("Unexpected event"),
1353         }
1354
1355         let events = nodes[0].node.get_and_clear_pending_events();
1356         assert_eq!(events.len(), 1);
1357         match events[0] {
1358                 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1359                         assert_eq!(payment_hash, payment_hash_2);
1360                         assert!(!rejected_by_dest);
1361                 },
1362                 _ => panic!("Unexpected event"),
1363         }
1364
1365         // Now forward all the pending HTLCs and claim them back
1366         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1367         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1368         check_added_monitors!(nodes[2], 1);
1369
1370         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1371         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1372         check_added_monitors!(nodes[1], 1);
1373         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1374
1375         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1376         check_added_monitors!(nodes[1], 1);
1377         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1378
1379         for ref update in as_updates.update_add_htlcs.iter() {
1380                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1381         }
1382         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1383         check_added_monitors!(nodes[2], 1);
1384         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1385         check_added_monitors!(nodes[2], 1);
1386         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1387
1388         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1389         check_added_monitors!(nodes[1], 1);
1390         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1391         check_added_monitors!(nodes[1], 1);
1392         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1393
1394         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1395         check_added_monitors!(nodes[2], 1);
1396
1397         expect_pending_htlcs_forwardable!(nodes[2]);
1398
1399         let events = nodes[2].node.get_and_clear_pending_events();
1400         assert_eq!(events.len(), payments.len());
1401         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1402                 match event {
1403                         &Event::PaymentReceived { ref payment_hash, .. } => {
1404                                 assert_eq!(*payment_hash, *hash);
1405                         },
1406                         _ => panic!("Unexpected event"),
1407                 };
1408         }
1409
1410         for (preimage, _) in payments.drain(..) {
1411                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1412         }
1413
1414         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1415 }
1416
1417 #[test]
1418 fn duplicate_htlc_test() {
1419         // Test that we accept duplicate payment_hash HTLCs across the network and that
1420         // claiming/failing them are all separate and don't affect each other
1421         let chanmon_cfgs = create_chanmon_cfgs(6);
1422         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1423         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1424         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1425
1426         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1427         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1428         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1429         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1430         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1431         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1432
1433         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1434
1435         *nodes[0].network_payment_count.borrow_mut() -= 1;
1436         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1437
1438         *nodes[0].network_payment_count.borrow_mut() -= 1;
1439         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1440
1441         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1442         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1443         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1444 }
1445
1446 #[test]
1447 fn test_duplicate_htlc_different_direction_onchain() {
1448         // Test that ChannelMonitor doesn't generate 2 preimage txn
1449         // when we have 2 HTLCs with same preimage that go across a node
1450         // in opposite directions.
1451         let chanmon_cfgs = create_chanmon_cfgs(2);
1452         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1453         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1454         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1455
1456         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1457
1458         // balancing
1459         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1460
1461         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1462
1463         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1464         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1465
1466         // Provide preimage to node 0 by claiming payment
1467         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1468         check_added_monitors!(nodes[0], 1);
1469
1470         // Broadcast node 1 commitment txn
1471         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1472
1473         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1474         let mut has_both_htlcs = 0; // check htlcs match ones committed
1475         for outp in remote_txn[0].output.iter() {
1476                 if outp.value == 800_000 / 1000 {
1477                         has_both_htlcs += 1;
1478                 } else if outp.value == 900_000 / 1000 {
1479                         has_both_htlcs += 1;
1480                 }
1481         }
1482         assert_eq!(has_both_htlcs, 2);
1483
1484         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1485         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1486         check_added_monitors!(nodes[0], 1);
1487
1488         // Check we only broadcast 1 timeout tx
1489         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1490         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()) };
1491         assert_eq!(claim_txn.len(), 5);
1492         check_spends!(claim_txn[2], chan_1.3);
1493         check_spends!(claim_txn[3], claim_txn[2]);
1494         assert_eq!(htlc_pair.0.input.len(), 1);
1495         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1496         check_spends!(htlc_pair.0, remote_txn[0]);
1497         assert_eq!(htlc_pair.1.input.len(), 1);
1498         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1499         check_spends!(htlc_pair.1, remote_txn[0]);
1500
1501         let events = nodes[0].node.get_and_clear_pending_msg_events();
1502         assert_eq!(events.len(), 2);
1503         for e in events {
1504                 match e {
1505                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1506                         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, .. } } => {
1507                                 assert!(update_add_htlcs.is_empty());
1508                                 assert!(update_fail_htlcs.is_empty());
1509                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1510                                 assert!(update_fail_malformed_htlcs.is_empty());
1511                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1512                         },
1513                         _ => panic!("Unexpected event"),
1514                 }
1515         }
1516 }
1517
1518 fn do_channel_reserve_test(test_recv: bool) {
1519
1520         let chanmon_cfgs = create_chanmon_cfgs(3);
1521         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1522         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1523         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1524         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1525         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1526
1527         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1528         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1529
1530         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1531         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1532
1533         macro_rules! get_route_and_payment_hash {
1534                 ($recv_value: expr) => {{
1535                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1536                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1537                         (route, payment_hash, payment_preimage)
1538                 }}
1539         };
1540
1541         macro_rules! expect_forward {
1542                 ($node: expr) => {{
1543                         let mut events = $node.node.get_and_clear_pending_msg_events();
1544                         assert_eq!(events.len(), 1);
1545                         check_added_monitors!($node, 1);
1546                         let payment_event = SendEvent::from_event(events.remove(0));
1547                         payment_event
1548                 }}
1549         }
1550
1551         let feemsat = 239; // somehow we know?
1552         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1553
1554         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1555
1556         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1557         {
1558                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1559                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1560                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1561                         assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
1562                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1563                 nodes[0].logger.assert_log("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);
1564         }
1565
1566         let mut htlc_id = 0;
1567         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1568         // nodes[0]'s wealth
1569         loop {
1570                 let amt_msat = recv_value_0 + total_fee_msat;
1571                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1572                         break;
1573                 }
1574                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1575                 htlc_id += 1;
1576
1577                 let (stat01_, stat11_, stat12_, stat22_) = (
1578                         get_channel_value_stat!(nodes[0], chan_1.2),
1579                         get_channel_value_stat!(nodes[1], chan_1.2),
1580                         get_channel_value_stat!(nodes[1], chan_2.2),
1581                         get_channel_value_stat!(nodes[2], chan_2.2),
1582                 );
1583
1584                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1585                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1586                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1587                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1588                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1589         }
1590
1591         {
1592                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1593                 // attempt to get channel_reserve violation
1594                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1595                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1596                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1597                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1598                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1599         }
1600
1601         // adding pending output
1602         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1603         let amt_msat_1 = recv_value_1 + total_fee_msat;
1604
1605         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1606         let payment_event_1 = {
1607                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1608                 check_added_monitors!(nodes[0], 1);
1609
1610                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1611                 assert_eq!(events.len(), 1);
1612                 SendEvent::from_event(events.remove(0))
1613         };
1614         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1615
1616         // channel reserve test with htlc pending output > 0
1617         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1618         {
1619                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1620                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1621                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1622                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1623                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1624         }
1625
1626         {
1627                 // test channel_reserve test on nodes[1] side
1628                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1629
1630                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1631                 let secp_ctx = Secp256k1::new();
1632                 let session_priv = SecretKey::from_slice(&{
1633                         let mut session_key = [0; 32];
1634                         let mut rng = thread_rng();
1635                         rng.fill_bytes(&mut session_key);
1636                         session_key
1637                 }).expect("RNG is bad!");
1638
1639                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1640                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1641                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], recv_value_2 + 1, &None, cur_height).unwrap();
1642                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1643                 let msg = msgs::UpdateAddHTLC {
1644                         channel_id: chan_1.2,
1645                         htlc_id,
1646                         amount_msat: htlc_msat,
1647                         payment_hash: our_payment_hash,
1648                         cltv_expiry: htlc_cltv,
1649                         onion_routing_packet: onion_packet,
1650                 };
1651
1652                 if test_recv {
1653                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1654                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1655                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1656                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1657                         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1658                         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1659                         check_added_monitors!(nodes[1], 1);
1660                         return;
1661                 }
1662         }
1663
1664         // split the rest to test holding cell
1665         let recv_value_21 = recv_value_2/2;
1666         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1667         {
1668                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1669                 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), stat.channel_reserve_msat);
1670         }
1671
1672         // now see if they go through on both sides
1673         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1674         // but this will stuck in the holding cell
1675         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
1676         check_added_monitors!(nodes[0], 0);
1677         let events = nodes[0].node.get_and_clear_pending_events();
1678         assert_eq!(events.len(), 0);
1679
1680         // test with outbound holding cell amount > 0
1681         {
1682                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1683                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1684                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1685                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1686                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1687         }
1688
1689         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1690         // this will also stuck in the holding cell
1691         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
1692         check_added_monitors!(nodes[0], 0);
1693         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1694         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1695
1696         // flush the pending htlc
1697         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1698         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1699         check_added_monitors!(nodes[1], 1);
1700
1701         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1702         check_added_monitors!(nodes[0], 1);
1703         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1704
1705         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1706         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1707         // No commitment_signed so get_event_msg's assert(len == 1) passes
1708         check_added_monitors!(nodes[0], 1);
1709
1710         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1711         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1712         check_added_monitors!(nodes[1], 1);
1713
1714         expect_pending_htlcs_forwardable!(nodes[1]);
1715
1716         let ref payment_event_11 = expect_forward!(nodes[1]);
1717         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1718         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1719
1720         expect_pending_htlcs_forwardable!(nodes[2]);
1721         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1722
1723         // flush the htlcs in the holding cell
1724         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1725         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1726         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1727         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1728         expect_pending_htlcs_forwardable!(nodes[1]);
1729
1730         let ref payment_event_3 = expect_forward!(nodes[1]);
1731         assert_eq!(payment_event_3.msgs.len(), 2);
1732         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1733         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1734
1735         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1736         expect_pending_htlcs_forwardable!(nodes[2]);
1737
1738         let events = nodes[2].node.get_and_clear_pending_events();
1739         assert_eq!(events.len(), 2);
1740         match events[0] {
1741                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1742                         assert_eq!(our_payment_hash_21, *payment_hash);
1743                         assert_eq!(*payment_secret, None);
1744                         assert_eq!(recv_value_21, amt);
1745                 },
1746                 _ => panic!("Unexpected event"),
1747         }
1748         match events[1] {
1749                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1750                         assert_eq!(our_payment_hash_22, *payment_hash);
1751                         assert_eq!(None, *payment_secret);
1752                         assert_eq!(recv_value_22, amt);
1753                 },
1754                 _ => panic!("Unexpected event"),
1755         }
1756
1757         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1758         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1759         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1760
1761         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);
1762         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1763         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1764         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1765
1766         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1767         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1768 }
1769
1770 #[test]
1771 fn channel_reserve_test() {
1772         do_channel_reserve_test(false);
1773         do_channel_reserve_test(true);
1774 }
1775
1776 #[test]
1777 fn channel_reserve_in_flight_removes() {
1778         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1779         // can send to its counterparty, but due to update ordering, the other side may not yet have
1780         // considered those HTLCs fully removed.
1781         // This tests that we don't count HTLCs which will not be included in the next remote
1782         // commitment transaction towards the reserve value (as it implies no commitment transaction
1783         // will be generated which violates the remote reserve value).
1784         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1785         // To test this we:
1786         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1787         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1788         //    you only consider the value of the first HTLC, it may not),
1789         //  * start routing a third HTLC from A to B,
1790         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1791         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1792         //  * deliver the first fulfill from B
1793         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1794         //    claim,
1795         //  * deliver A's response CS and RAA.
1796         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1797         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1798         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1799         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1800         let chanmon_cfgs = create_chanmon_cfgs(2);
1801         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1802         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1803         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1804         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1805
1806         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1807         // Route the first two HTLCs.
1808         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1809         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1810
1811         // Start routing the third HTLC (this is just used to get everyone in the right state).
1812         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1813         let send_1 = {
1814                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1815                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
1816                 check_added_monitors!(nodes[0], 1);
1817                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1818                 assert_eq!(events.len(), 1);
1819                 SendEvent::from_event(events.remove(0))
1820         };
1821
1822         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1823         // initial fulfill/CS.
1824         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1825         check_added_monitors!(nodes[1], 1);
1826         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1827
1828         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1829         // remove the second HTLC when we send the HTLC back from B to A.
1830         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
1831         check_added_monitors!(nodes[1], 1);
1832         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1833
1834         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1835         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1836         check_added_monitors!(nodes[0], 1);
1837         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1838         expect_payment_sent!(nodes[0], payment_preimage_1);
1839
1840         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1841         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1842         check_added_monitors!(nodes[1], 1);
1843         // B is already AwaitingRAA, so cant generate a CS here
1844         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1845
1846         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1847         check_added_monitors!(nodes[1], 1);
1848         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1849
1850         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1851         check_added_monitors!(nodes[0], 1);
1852         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1853
1854         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1855         check_added_monitors!(nodes[1], 1);
1856         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1857
1858         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1859         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1860         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1861         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1862         // on-chain as necessary).
1863         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1864         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1865         check_added_monitors!(nodes[0], 1);
1866         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1867         expect_payment_sent!(nodes[0], payment_preimage_2);
1868
1869         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1870         check_added_monitors!(nodes[1], 1);
1871         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1872
1873         expect_pending_htlcs_forwardable!(nodes[1]);
1874         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1875
1876         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1877         // resolve the second HTLC from A's point of view.
1878         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1879         check_added_monitors!(nodes[0], 1);
1880         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1881
1882         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1883         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1884         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1885         let send_2 = {
1886                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1887                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
1888                 check_added_monitors!(nodes[1], 1);
1889                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1890                 assert_eq!(events.len(), 1);
1891                 SendEvent::from_event(events.remove(0))
1892         };
1893
1894         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1895         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1896         check_added_monitors!(nodes[0], 1);
1897         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1898
1899         // Now just resolve all the outstanding messages/HTLCs for completeness...
1900
1901         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1902         check_added_monitors!(nodes[1], 1);
1903         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1904
1905         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1906         check_added_monitors!(nodes[1], 1);
1907
1908         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1909         check_added_monitors!(nodes[0], 1);
1910         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1911
1912         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1913         check_added_monitors!(nodes[1], 1);
1914         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1915
1916         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1917         check_added_monitors!(nodes[0], 1);
1918
1919         expect_pending_htlcs_forwardable!(nodes[0]);
1920         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1921
1922         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1923         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1924 }
1925
1926 #[test]
1927 fn channel_monitor_network_test() {
1928         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1929         // tests that ChannelMonitor is able to recover from various states.
1930         let chanmon_cfgs = create_chanmon_cfgs(5);
1931         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1932         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1933         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1934
1935         // Create some initial channels
1936         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1937         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1938         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1939         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1940
1941         // Rebalance the network a bit by relaying one payment through all the channels...
1942         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1943         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1944         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1945         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1946
1947         // Simple case with no pending HTLCs:
1948         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1949         check_added_monitors!(nodes[1], 1);
1950         {
1951                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1952                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1953                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1954                 check_added_monitors!(nodes[0], 1);
1955                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1956         }
1957         get_announce_close_broadcast_events(&nodes, 0, 1);
1958         assert_eq!(nodes[0].node.list_channels().len(), 0);
1959         assert_eq!(nodes[1].node.list_channels().len(), 1);
1960
1961         // One pending HTLC is discarded by the force-close:
1962         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1963
1964         // Simple case of one pending HTLC to HTLC-Timeout
1965         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1966         check_added_monitors!(nodes[1], 1);
1967         {
1968                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1969                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1970                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1971                 check_added_monitors!(nodes[2], 1);
1972                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1973         }
1974         get_announce_close_broadcast_events(&nodes, 1, 2);
1975         assert_eq!(nodes[1].node.list_channels().len(), 0);
1976         assert_eq!(nodes[2].node.list_channels().len(), 1);
1977
1978         macro_rules! claim_funds {
1979                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1980                         {
1981                                 assert!($node.node.claim_funds($preimage, &None, $amount));
1982                                 check_added_monitors!($node, 1);
1983
1984                                 let events = $node.node.get_and_clear_pending_msg_events();
1985                                 assert_eq!(events.len(), 1);
1986                                 match events[0] {
1987                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1988                                                 assert!(update_add_htlcs.is_empty());
1989                                                 assert!(update_fail_htlcs.is_empty());
1990                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1991                                         },
1992                                         _ => panic!("Unexpected event"),
1993                                 };
1994                         }
1995                 }
1996         }
1997
1998         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
1999         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2000         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2001         check_added_monitors!(nodes[2], 1);
2002         let node2_commitment_txid;
2003         {
2004                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2005                 node2_commitment_txid = node_txn[0].txid();
2006
2007                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2008                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2009
2010                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2011                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2012                 check_added_monitors!(nodes[3], 1);
2013
2014                 check_preimage_claim(&nodes[3], &node_txn);
2015         }
2016         get_announce_close_broadcast_events(&nodes, 2, 3);
2017         assert_eq!(nodes[2].node.list_channels().len(), 0);
2018         assert_eq!(nodes[3].node.list_channels().len(), 1);
2019
2020         { // Cheat and reset nodes[4]'s height to 1
2021                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2022                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2023         }
2024
2025         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2026         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2027         // One pending HTLC to time out:
2028         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2029         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2030         // buffer space).
2031
2032         {
2033                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2034                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2035                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2036                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2037                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2038                 }
2039                 check_added_monitors!(nodes[3], 1);
2040
2041                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2042                 {
2043                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2044                         node_txn.retain(|tx| {
2045                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2046                                         false
2047                                 } else { true }
2048                         });
2049                 }
2050
2051                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2052
2053                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2054                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2055
2056                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2057
2058                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2059                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2060                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2061                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2062                 }
2063
2064                 check_added_monitors!(nodes[4], 1);
2065                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2066
2067                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2068                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2069
2070                 check_preimage_claim(&nodes[4], &node_txn);
2071         }
2072         get_announce_close_broadcast_events(&nodes, 3, 4);
2073         assert_eq!(nodes[3].node.list_channels().len(), 0);
2074         assert_eq!(nodes[4].node.list_channels().len(), 0);
2075 }
2076
2077 #[test]
2078 fn test_justice_tx() {
2079         // Test justice txn built on revoked HTLC-Success tx, against both sides
2080         let mut alice_config = UserConfig::default();
2081         alice_config.channel_options.announced_channel = true;
2082         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2083         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2084         let mut bob_config = UserConfig::default();
2085         bob_config.channel_options.announced_channel = true;
2086         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2087         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2088         let user_cfgs = [Some(alice_config), Some(bob_config)];
2089         let chanmon_cfgs = create_chanmon_cfgs(2);
2090         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2091         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2092         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2093         // Create some new channels:
2094         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2095
2096         // A pending HTLC which will be revoked:
2097         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2098         // Get the will-be-revoked local txn from nodes[0]
2099         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2100         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2101         assert_eq!(revoked_local_txn[0].input.len(), 1);
2102         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2103         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2104         assert_eq!(revoked_local_txn[1].input.len(), 1);
2105         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2106         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2107         // Revoke the old state
2108         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2109
2110         {
2111                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2112                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2113                 {
2114                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2115                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2116                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2117
2118                         check_spends!(node_txn[0], revoked_local_txn[0]);
2119                         node_txn.swap_remove(0);
2120                         node_txn.truncate(1);
2121                 }
2122                 check_added_monitors!(nodes[1], 1);
2123                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2124
2125                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2126                 // Verify broadcast of revoked HTLC-timeout
2127                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2128                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2129                 check_added_monitors!(nodes[0], 1);
2130                 // Broadcast revoked HTLC-timeout on node 1
2131                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2132                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2133         }
2134         get_announce_close_broadcast_events(&nodes, 0, 1);
2135
2136         assert_eq!(nodes[0].node.list_channels().len(), 0);
2137         assert_eq!(nodes[1].node.list_channels().len(), 0);
2138
2139         // We test justice_tx build by A on B's revoked HTLC-Success tx
2140         // Create some new channels:
2141         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2142         {
2143                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2144                 node_txn.clear();
2145         }
2146
2147         // A pending HTLC which will be revoked:
2148         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2149         // Get the will-be-revoked local txn from B
2150         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2151         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2152         assert_eq!(revoked_local_txn[0].input.len(), 1);
2153         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2154         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2155         // Revoke the old state
2156         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2157         {
2158                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2159                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2160                 {
2161                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2162                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2163                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2164
2165                         check_spends!(node_txn[0], revoked_local_txn[0]);
2166                         node_txn.swap_remove(0);
2167                 }
2168                 check_added_monitors!(nodes[0], 1);
2169                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2170
2171                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2172                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2173                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2174                 check_added_monitors!(nodes[1], 1);
2175                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2176                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2177         }
2178         get_announce_close_broadcast_events(&nodes, 0, 1);
2179         assert_eq!(nodes[0].node.list_channels().len(), 0);
2180         assert_eq!(nodes[1].node.list_channels().len(), 0);
2181 }
2182
2183 #[test]
2184 fn revoked_output_claim() {
2185         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2186         // transaction is broadcast by its counterparty
2187         let chanmon_cfgs = create_chanmon_cfgs(2);
2188         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2189         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2190         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2191         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2192         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2193         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2194         assert_eq!(revoked_local_txn.len(), 1);
2195         // Only output is the full channel value back to nodes[0]:
2196         assert_eq!(revoked_local_txn[0].output.len(), 1);
2197         // Send a payment through, updating everyone's latest commitment txn
2198         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2199
2200         // Inform nodes[1] that nodes[0] broadcast a stale tx
2201         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2202         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2203         check_added_monitors!(nodes[1], 1);
2204         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2205         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2206
2207         check_spends!(node_txn[0], revoked_local_txn[0]);
2208         check_spends!(node_txn[1], chan_1.3);
2209
2210         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2211         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2212         get_announce_close_broadcast_events(&nodes, 0, 1);
2213         check_added_monitors!(nodes[0], 1)
2214 }
2215
2216 #[test]
2217 fn claim_htlc_outputs_shared_tx() {
2218         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2219         let chanmon_cfgs = create_chanmon_cfgs(2);
2220         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2221         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2222         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2223
2224         // Create some new channel:
2225         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2226
2227         // Rebalance the network to generate htlc in the two directions
2228         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2229         // 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
2230         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2231         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2232
2233         // Get the will-be-revoked local txn from node[0]
2234         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2235         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2236         assert_eq!(revoked_local_txn[0].input.len(), 1);
2237         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2238         assert_eq!(revoked_local_txn[1].input.len(), 1);
2239         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2240         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2241         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2242
2243         //Revoke the old state
2244         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2245
2246         {
2247                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2248                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2249                 check_added_monitors!(nodes[0], 1);
2250                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2251                 check_added_monitors!(nodes[1], 1);
2252                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2253
2254                 let events = nodes[1].node.get_and_clear_pending_events();
2255                 assert_eq!(events.len(), 1);
2256                 match events[0] {
2257                         Event::PaymentFailed { payment_hash, .. } => {
2258                                 assert_eq!(payment_hash, payment_hash_2);
2259                         },
2260                         _ => panic!("Unexpected event"),
2261                 }
2262
2263                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2264                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2265
2266                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2267                 check_spends!(node_txn[0], revoked_local_txn[0]);
2268
2269                 let mut witness_lens = BTreeSet::new();
2270                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2271                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2272                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2273                 assert_eq!(witness_lens.len(), 3);
2274                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2275                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2276                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2277
2278                 // Next nodes[1] broadcasts its current local tx state:
2279                 assert_eq!(node_txn[1].input.len(), 1);
2280                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2281
2282                 assert_eq!(node_txn[2].input.len(), 1);
2283                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2284                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2285                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2286                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2287                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2288         }
2289         get_announce_close_broadcast_events(&nodes, 0, 1);
2290         assert_eq!(nodes[0].node.list_channels().len(), 0);
2291         assert_eq!(nodes[1].node.list_channels().len(), 0);
2292 }
2293
2294 #[test]
2295 fn claim_htlc_outputs_single_tx() {
2296         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2297         let chanmon_cfgs = create_chanmon_cfgs(2);
2298         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2299         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2300         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2301
2302         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2303
2304         // Rebalance the network to generate htlc in the two directions
2305         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2306         // 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
2307         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2308         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2309         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2310
2311         // Get the will-be-revoked local txn from node[0]
2312         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2313
2314         //Revoke the old state
2315         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2316
2317         {
2318                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2319                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2320                 check_added_monitors!(nodes[0], 1);
2321                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2322                 check_added_monitors!(nodes[1], 1);
2323                 expect_pending_htlcs_forwardable_ignore!(nodes[0]);
2324
2325                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2326
2327                 let events = nodes[1].node.get_and_clear_pending_events();
2328                 assert_eq!(events.len(), 1);
2329                 match events[0] {
2330                         Event::PaymentFailed { payment_hash, .. } => {
2331                                 assert_eq!(payment_hash, payment_hash_2);
2332                         },
2333                         _ => panic!("Unexpected event"),
2334                 }
2335
2336                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2337                 assert_eq!(node_txn.len(), 9);
2338                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2339                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2340                 // 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)
2341                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2342
2343                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2344                 assert_eq!(node_txn[2].input.len(), 1);
2345                 check_spends!(node_txn[2], chan_1.3);
2346                 assert_eq!(node_txn[3].input.len(), 1);
2347                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2348                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2349                 check_spends!(node_txn[3], node_txn[2]);
2350
2351                 // Justice transactions are indices 1-2-4
2352                 assert_eq!(node_txn[0].input.len(), 1);
2353                 assert_eq!(node_txn[1].input.len(), 1);
2354                 assert_eq!(node_txn[4].input.len(), 1);
2355
2356                 check_spends!(node_txn[0], revoked_local_txn[0]);
2357                 check_spends!(node_txn[1], revoked_local_txn[0]);
2358                 check_spends!(node_txn[4], revoked_local_txn[0]);
2359
2360                 let mut witness_lens = BTreeSet::new();
2361                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2362                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2363                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2364                 assert_eq!(witness_lens.len(), 3);
2365                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2366                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2367                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2368         }
2369         get_announce_close_broadcast_events(&nodes, 0, 1);
2370         assert_eq!(nodes[0].node.list_channels().len(), 0);
2371         assert_eq!(nodes[1].node.list_channels().len(), 0);
2372 }
2373
2374 #[test]
2375 fn test_htlc_on_chain_success() {
2376         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2377         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2378         // broadcasting the right event to other nodes in payment path.
2379         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2380         // A --------------------> B ----------------------> C (preimage)
2381         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2382         // commitment transaction was broadcast.
2383         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2384         // towards B.
2385         // B should be able to claim via preimage if A then broadcasts its local tx.
2386         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2387         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2388         // PaymentSent event).
2389
2390         let chanmon_cfgs = create_chanmon_cfgs(3);
2391         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2392         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2393         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2394
2395         // Create some initial channels
2396         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2397         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2398
2399         // Rebalance the network a bit by relaying one payment through all the channels...
2400         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2401         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2402
2403         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2404         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2405         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2406
2407         // Broadcast legit commitment tx from C on B's chain
2408         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2409         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2410         assert_eq!(commitment_tx.len(), 1);
2411         check_spends!(commitment_tx[0], chan_2.3);
2412         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2413         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2414         check_added_monitors!(nodes[2], 2);
2415         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2416         assert!(updates.update_add_htlcs.is_empty());
2417         assert!(updates.update_fail_htlcs.is_empty());
2418         assert!(updates.update_fail_malformed_htlcs.is_empty());
2419         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2420
2421         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2422         check_closed_broadcast!(nodes[2], false);
2423         check_added_monitors!(nodes[2], 1);
2424         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)
2425         assert_eq!(node_txn.len(), 5);
2426         assert_eq!(node_txn[0], node_txn[3]);
2427         assert_eq!(node_txn[1], node_txn[4]);
2428         assert_eq!(node_txn[2], commitment_tx[0]);
2429         check_spends!(node_txn[0], commitment_tx[0]);
2430         check_spends!(node_txn[1], commitment_tx[0]);
2431         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2432         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2433         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2434         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2435         assert_eq!(node_txn[0].lock_time, 0);
2436         assert_eq!(node_txn[1].lock_time, 0);
2437
2438         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2439         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2440         {
2441                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2442                 assert_eq!(added_monitors.len(), 1);
2443                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2444                 added_monitors.clear();
2445         }
2446         let events = nodes[1].node.get_and_clear_pending_msg_events();
2447         {
2448                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2449                 assert_eq!(added_monitors.len(), 2);
2450                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2451                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2452                 added_monitors.clear();
2453         }
2454         assert_eq!(events.len(), 2);
2455         match events[0] {
2456                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2457                 _ => panic!("Unexpected event"),
2458         }
2459         match events[1] {
2460                 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, .. } } => {
2461                         assert!(update_add_htlcs.is_empty());
2462                         assert!(update_fail_htlcs.is_empty());
2463                         assert_eq!(update_fulfill_htlcs.len(), 1);
2464                         assert!(update_fail_malformed_htlcs.is_empty());
2465                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2466                 },
2467                 _ => panic!("Unexpected event"),
2468         };
2469         macro_rules! check_tx_local_broadcast {
2470                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2471                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2472                         assert_eq!(node_txn.len(), 5);
2473                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2474                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2475                         check_spends!(node_txn[0], $commitment_tx);
2476                         check_spends!(node_txn[1], $commitment_tx);
2477                         assert_ne!(node_txn[0].lock_time, 0);
2478                         assert_ne!(node_txn[1].lock_time, 0);
2479                         if $htlc_offered {
2480                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2481                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2482                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2483                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2484                         } else {
2485                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2486                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2487                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2488                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2489                         }
2490                         check_spends!(node_txn[2], $chan_tx);
2491                         check_spends!(node_txn[3], node_txn[2]);
2492                         check_spends!(node_txn[4], node_txn[2]);
2493                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2494                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2495                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2496                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2497                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2498                         assert_ne!(node_txn[3].lock_time, 0);
2499                         assert_ne!(node_txn[4].lock_time, 0);
2500                         node_txn.clear();
2501                 } }
2502         }
2503         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2504         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2505         // timeout-claim of the output that nodes[2] just claimed via success.
2506         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2507
2508         // Broadcast legit commitment tx from A on B's chain
2509         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2510         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2511         check_spends!(commitment_tx[0], chan_1.3);
2512         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2513         check_closed_broadcast!(nodes[1], false);
2514         check_added_monitors!(nodes[1], 1);
2515         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2516         assert_eq!(node_txn.len(), 4);
2517         check_spends!(node_txn[0], commitment_tx[0]);
2518         assert_eq!(node_txn[0].input.len(), 2);
2519         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2520         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2521         assert_eq!(node_txn[0].lock_time, 0);
2522         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2523         check_spends!(node_txn[1], chan_1.3);
2524         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2525         check_spends!(node_txn[2], node_txn[1]);
2526         check_spends!(node_txn[3], node_txn[1]);
2527         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2528         // we already checked the same situation with A.
2529
2530         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2531         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2532         check_closed_broadcast!(nodes[0], false);
2533         check_added_monitors!(nodes[0], 1);
2534         let events = nodes[0].node.get_and_clear_pending_events();
2535         assert_eq!(events.len(), 2);
2536         let mut first_claimed = false;
2537         for event in events {
2538                 match event {
2539                         Event::PaymentSent { payment_preimage } => {
2540                                 if payment_preimage == our_payment_preimage {
2541                                         assert!(!first_claimed);
2542                                         first_claimed = true;
2543                                 } else {
2544                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2545                                 }
2546                         },
2547                         _ => panic!("Unexpected event"),
2548                 }
2549         }
2550         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2551 }
2552
2553 #[test]
2554 fn test_htlc_on_chain_timeout() {
2555         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2556         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2557         // broadcasting the right event to other nodes in payment path.
2558         // A ------------------> B ----------------------> C (timeout)
2559         //    B's commitment tx                 C's commitment tx
2560         //            \                                  \
2561         //         B's HTLC timeout tx               B's timeout tx
2562
2563         let chanmon_cfgs = create_chanmon_cfgs(3);
2564         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2565         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2566         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2567
2568         // Create some intial channels
2569         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2570         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2571
2572         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2573         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2574         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2575
2576         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2577         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2578
2579         // Broadcast legit commitment tx from C on B's chain
2580         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2581         check_spends!(commitment_tx[0], chan_2.3);
2582         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2583         check_added_monitors!(nodes[2], 0);
2584         expect_pending_htlcs_forwardable!(nodes[2]);
2585         check_added_monitors!(nodes[2], 1);
2586
2587         let events = nodes[2].node.get_and_clear_pending_msg_events();
2588         assert_eq!(events.len(), 1);
2589         match events[0] {
2590                 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, .. } } => {
2591                         assert!(update_add_htlcs.is_empty());
2592                         assert!(!update_fail_htlcs.is_empty());
2593                         assert!(update_fulfill_htlcs.is_empty());
2594                         assert!(update_fail_malformed_htlcs.is_empty());
2595                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2596                 },
2597                 _ => panic!("Unexpected event"),
2598         };
2599         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2600         check_closed_broadcast!(nodes[2], false);
2601         check_added_monitors!(nodes[2], 1);
2602         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2603         assert_eq!(node_txn.len(), 1);
2604         check_spends!(node_txn[0], chan_2.3);
2605         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2606
2607         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2608         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2609         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2610         let timeout_tx;
2611         {
2612                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2613                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2614                 assert_eq!(node_txn[1], node_txn[3]);
2615                 assert_eq!(node_txn[2], node_txn[4]);
2616
2617                 check_spends!(node_txn[0], commitment_tx[0]);
2618                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2619
2620                 check_spends!(node_txn[1], chan_2.3);
2621                 check_spends!(node_txn[2], node_txn[1]);
2622                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2623                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2624
2625                 timeout_tx = node_txn[0].clone();
2626                 node_txn.clear();
2627         }
2628
2629         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2630         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2631         check_added_monitors!(nodes[1], 1);
2632         check_closed_broadcast!(nodes[1], false);
2633
2634         expect_pending_htlcs_forwardable!(nodes[1]);
2635         check_added_monitors!(nodes[1], 1);
2636         let events = nodes[1].node.get_and_clear_pending_msg_events();
2637         assert_eq!(events.len(), 1);
2638         match events[0] {
2639                 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, .. } } => {
2640                         assert!(update_add_htlcs.is_empty());
2641                         assert!(!update_fail_htlcs.is_empty());
2642                         assert!(update_fulfill_htlcs.is_empty());
2643                         assert!(update_fail_malformed_htlcs.is_empty());
2644                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2645                 },
2646                 _ => panic!("Unexpected event"),
2647         };
2648         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
2649         assert_eq!(node_txn.len(), 0);
2650
2651         // Broadcast legit commitment tx from B on A's chain
2652         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2653         check_spends!(commitment_tx[0], chan_1.3);
2654
2655         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2656         check_closed_broadcast!(nodes[0], false);
2657         check_added_monitors!(nodes[0], 1);
2658         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2659         assert_eq!(node_txn.len(), 3);
2660         check_spends!(node_txn[0], commitment_tx[0]);
2661         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2662         check_spends!(node_txn[1], chan_1.3);
2663         check_spends!(node_txn[2], node_txn[1]);
2664         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2665         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2666 }
2667
2668 #[test]
2669 fn test_simple_commitment_revoked_fail_backward() {
2670         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2671         // and fail backward accordingly.
2672
2673         let chanmon_cfgs = create_chanmon_cfgs(3);
2674         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2675         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2676         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2677
2678         // Create some initial channels
2679         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2680         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2681
2682         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2683         // Get the will-be-revoked local txn from nodes[2]
2684         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2685         // Revoke the old state
2686         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2687
2688         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2689
2690         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2691         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2692         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2693         check_added_monitors!(nodes[1], 1);
2694         check_closed_broadcast!(nodes[1], false);
2695
2696         expect_pending_htlcs_forwardable!(nodes[1]);
2697         check_added_monitors!(nodes[1], 1);
2698         let events = nodes[1].node.get_and_clear_pending_msg_events();
2699         assert_eq!(events.len(), 1);
2700         match events[0] {
2701                 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, .. } } => {
2702                         assert!(update_add_htlcs.is_empty());
2703                         assert_eq!(update_fail_htlcs.len(), 1);
2704                         assert!(update_fulfill_htlcs.is_empty());
2705                         assert!(update_fail_malformed_htlcs.is_empty());
2706                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2707
2708                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2709                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2710
2711                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2712                         assert_eq!(events.len(), 1);
2713                         match events[0] {
2714                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2715                                 _ => panic!("Unexpected event"),
2716                         }
2717                         let events = nodes[0].node.get_and_clear_pending_events();
2718                         assert_eq!(events.len(), 1);
2719                         match events[0] {
2720                                 Event::PaymentFailed { .. } => {},
2721                                 _ => panic!("Unexpected event"),
2722                         }
2723                 },
2724                 _ => panic!("Unexpected event"),
2725         }
2726 }
2727
2728 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2729         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2730         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2731         // commitment transaction anymore.
2732         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2733         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2734         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2735         // technically disallowed and we should probably handle it reasonably.
2736         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2737         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2738         // transactions:
2739         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2740         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2741         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2742         //   and once they revoke the previous commitment transaction (allowing us to send a new
2743         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2744         let chanmon_cfgs = create_chanmon_cfgs(3);
2745         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2746         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2747         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2748
2749         // Create some initial channels
2750         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2751         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2752
2753         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2754         // Get the will-be-revoked local txn from nodes[2]
2755         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2756         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2757         // Revoke the old state
2758         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2759
2760         let value = if use_dust {
2761                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2762                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2763                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2764         } else { 3000000 };
2765
2766         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2767         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2768         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2769
2770         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
2771         expect_pending_htlcs_forwardable!(nodes[2]);
2772         check_added_monitors!(nodes[2], 1);
2773         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2774         assert!(updates.update_add_htlcs.is_empty());
2775         assert!(updates.update_fulfill_htlcs.is_empty());
2776         assert!(updates.update_fail_malformed_htlcs.is_empty());
2777         assert_eq!(updates.update_fail_htlcs.len(), 1);
2778         assert!(updates.update_fee.is_none());
2779         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2780         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2781         // Drop the last RAA from 3 -> 2
2782
2783         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
2784         expect_pending_htlcs_forwardable!(nodes[2]);
2785         check_added_monitors!(nodes[2], 1);
2786         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2787         assert!(updates.update_add_htlcs.is_empty());
2788         assert!(updates.update_fulfill_htlcs.is_empty());
2789         assert!(updates.update_fail_malformed_htlcs.is_empty());
2790         assert_eq!(updates.update_fail_htlcs.len(), 1);
2791         assert!(updates.update_fee.is_none());
2792         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2793         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2794         check_added_monitors!(nodes[1], 1);
2795         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2796         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2797         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2798         check_added_monitors!(nodes[2], 1);
2799
2800         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
2801         expect_pending_htlcs_forwardable!(nodes[2]);
2802         check_added_monitors!(nodes[2], 1);
2803         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2804         assert!(updates.update_add_htlcs.is_empty());
2805         assert!(updates.update_fulfill_htlcs.is_empty());
2806         assert!(updates.update_fail_malformed_htlcs.is_empty());
2807         assert_eq!(updates.update_fail_htlcs.len(), 1);
2808         assert!(updates.update_fee.is_none());
2809         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2810         // At this point first_payment_hash has dropped out of the latest two commitment
2811         // transactions that nodes[1] is tracking...
2812         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2813         check_added_monitors!(nodes[1], 1);
2814         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2815         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2816         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2817         check_added_monitors!(nodes[2], 1);
2818
2819         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2820         // on nodes[2]'s RAA.
2821         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2822         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2823         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
2824         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2825         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2826         check_added_monitors!(nodes[1], 0);
2827
2828         if deliver_bs_raa {
2829                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2830                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2831                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2832                 check_added_monitors!(nodes[1], 1);
2833                 let events = nodes[1].node.get_and_clear_pending_events();
2834                 assert_eq!(events.len(), 1);
2835                 match events[0] {
2836                         Event::PendingHTLCsForwardable { .. } => { },
2837                         _ => panic!("Unexpected event"),
2838                 };
2839                 // Deliberately don't process the pending fail-back so they all fail back at once after
2840                 // block connection just like the !deliver_bs_raa case
2841         }
2842
2843         let mut failed_htlcs = HashSet::new();
2844         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2845
2846         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2847         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2848         check_added_monitors!(nodes[1], 1);
2849         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2850
2851         let events = nodes[1].node.get_and_clear_pending_events();
2852         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2853         match events[0] {
2854                 Event::PaymentFailed { ref payment_hash, .. } => {
2855                         assert_eq!(*payment_hash, fourth_payment_hash);
2856                 },
2857                 _ => panic!("Unexpected event"),
2858         }
2859         if !deliver_bs_raa {
2860                 match events[1] {
2861                         Event::PendingHTLCsForwardable { .. } => { },
2862                         _ => panic!("Unexpected event"),
2863                 };
2864         }
2865         nodes[1].node.process_pending_htlc_forwards();
2866         check_added_monitors!(nodes[1], 1);
2867
2868         let events = nodes[1].node.get_and_clear_pending_msg_events();
2869         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2870         match events[if deliver_bs_raa { 1 } else { 0 }] {
2871                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2872                 _ => panic!("Unexpected event"),
2873         }
2874         if deliver_bs_raa {
2875                 match events[0] {
2876                         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, .. } } => {
2877                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2878                                 assert_eq!(update_add_htlcs.len(), 1);
2879                                 assert!(update_fulfill_htlcs.is_empty());
2880                                 assert!(update_fail_htlcs.is_empty());
2881                                 assert!(update_fail_malformed_htlcs.is_empty());
2882                         },
2883                         _ => panic!("Unexpected event"),
2884                 }
2885         }
2886         match events[if deliver_bs_raa { 2 } else { 1 }] {
2887                 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, .. } } => {
2888                         assert!(update_add_htlcs.is_empty());
2889                         assert_eq!(update_fail_htlcs.len(), 3);
2890                         assert!(update_fulfill_htlcs.is_empty());
2891                         assert!(update_fail_malformed_htlcs.is_empty());
2892                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2893
2894                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2895                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2896                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2897
2898                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2899
2900                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2901                         // If we delivered B's RAA we got an unknown preimage error, not something
2902                         // that we should update our routing table for.
2903                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2904                         for event in events {
2905                                 match event {
2906                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2907                                         _ => panic!("Unexpected event"),
2908                                 }
2909                         }
2910                         let events = nodes[0].node.get_and_clear_pending_events();
2911                         assert_eq!(events.len(), 3);
2912                         match events[0] {
2913                                 Event::PaymentFailed { ref payment_hash, .. } => {
2914                                         assert!(failed_htlcs.insert(payment_hash.0));
2915                                 },
2916                                 _ => panic!("Unexpected event"),
2917                         }
2918                         match events[1] {
2919                                 Event::PaymentFailed { ref payment_hash, .. } => {
2920                                         assert!(failed_htlcs.insert(payment_hash.0));
2921                                 },
2922                                 _ => panic!("Unexpected event"),
2923                         }
2924                         match events[2] {
2925                                 Event::PaymentFailed { ref payment_hash, .. } => {
2926                                         assert!(failed_htlcs.insert(payment_hash.0));
2927                                 },
2928                                 _ => panic!("Unexpected event"),
2929                         }
2930                 },
2931                 _ => panic!("Unexpected event"),
2932         }
2933
2934         assert!(failed_htlcs.contains(&first_payment_hash.0));
2935         assert!(failed_htlcs.contains(&second_payment_hash.0));
2936         assert!(failed_htlcs.contains(&third_payment_hash.0));
2937 }
2938
2939 #[test]
2940 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2941         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2942         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2943         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2944         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2945 }
2946
2947 #[test]
2948 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2949         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2950         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2951         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2952         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2953 }
2954
2955 #[test]
2956 fn fail_backward_pending_htlc_upon_channel_failure() {
2957         let chanmon_cfgs = create_chanmon_cfgs(2);
2958         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2959         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2960         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2961         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::supported(), InitFeatures::supported());
2962
2963         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
2964         {
2965                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
2966                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2967                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
2968                 check_added_monitors!(nodes[0], 1);
2969
2970                 let payment_event = {
2971                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2972                         assert_eq!(events.len(), 1);
2973                         SendEvent::from_event(events.remove(0))
2974                 };
2975                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
2976                 assert_eq!(payment_event.msgs.len(), 1);
2977         }
2978
2979         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
2980         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2981         {
2982                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2983                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
2984                 check_added_monitors!(nodes[0], 0);
2985
2986                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2987         }
2988
2989         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
2990         {
2991                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2992                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
2993
2994                 let secp_ctx = Secp256k1::new();
2995                 let session_priv = {
2996                         let mut session_key = [0; 32];
2997                         let mut rng = thread_rng();
2998                         rng.fill_bytes(&mut session_key);
2999                         SecretKey::from_slice(&session_key).expect("RNG is bad!")
3000                 };
3001
3002                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3003                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3004                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3005                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3006
3007                 // Send a 0-msat update_add_htlc to fail the channel.
3008                 let update_add_htlc = msgs::UpdateAddHTLC {
3009                         channel_id: chan.2,
3010                         htlc_id: 0,
3011                         amount_msat: 0,
3012                         payment_hash,
3013                         cltv_expiry,
3014                         onion_routing_packet,
3015                 };
3016                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3017         }
3018
3019         // Check that Alice fails backward the pending HTLC from the second payment.
3020         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3021         check_closed_broadcast!(nodes[0], true);
3022         check_added_monitors!(nodes[0], 1);
3023 }
3024
3025 #[test]
3026 fn test_htlc_ignore_latest_remote_commitment() {
3027         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3028         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3029         let chanmon_cfgs = create_chanmon_cfgs(2);
3030         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3031         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3032         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3033         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3034
3035         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3036         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3037         check_closed_broadcast!(nodes[0], false);
3038         check_added_monitors!(nodes[0], 1);
3039
3040         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3041         assert_eq!(node_txn.len(), 2);
3042
3043         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3044         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3045         check_closed_broadcast!(nodes[1], false);
3046         check_added_monitors!(nodes[1], 1);
3047
3048         // Duplicate the block_connected call since this may happen due to other listeners
3049         // registering new transactions
3050         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3051 }
3052
3053 #[test]
3054 fn test_force_close_fail_back() {
3055         // Check which HTLCs are failed-backwards on channel force-closure
3056         let chanmon_cfgs = create_chanmon_cfgs(3);
3057         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3058         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3059         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3060         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3061         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3062
3063         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
3064
3065         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3066
3067         let mut payment_event = {
3068                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3069                 check_added_monitors!(nodes[0], 1);
3070
3071                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3072                 assert_eq!(events.len(), 1);
3073                 SendEvent::from_event(events.remove(0))
3074         };
3075
3076         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3077         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3078
3079         expect_pending_htlcs_forwardable!(nodes[1]);
3080
3081         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3082         assert_eq!(events_2.len(), 1);
3083         payment_event = SendEvent::from_event(events_2.remove(0));
3084         assert_eq!(payment_event.msgs.len(), 1);
3085
3086         check_added_monitors!(nodes[1], 1);
3087         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3088         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3089         check_added_monitors!(nodes[2], 1);
3090         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3091
3092         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3093         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3094         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3095
3096         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3097         check_closed_broadcast!(nodes[2], false);
3098         check_added_monitors!(nodes[2], 1);
3099         let tx = {
3100                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3101                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3102                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3103                 // back to nodes[1] upon timeout otherwise.
3104                 assert_eq!(node_txn.len(), 1);
3105                 node_txn.remove(0)
3106         };
3107
3108         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3109         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3110
3111         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3112         check_closed_broadcast!(nodes[1], false);
3113         check_added_monitors!(nodes[1], 1);
3114
3115         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3116         {
3117                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3118                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
3119                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3120         }
3121         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3122         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3123         assert_eq!(node_txn.len(), 1);
3124         assert_eq!(node_txn[0].input.len(), 1);
3125         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3126         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3127         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3128
3129         check_spends!(node_txn[0], tx);
3130 }
3131
3132 #[test]
3133 fn test_unconf_chan() {
3134         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3135         let chanmon_cfgs = create_chanmon_cfgs(2);
3136         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3137         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3138         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3139         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3140
3141         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3142         assert_eq!(channel_state.by_id.len(), 1);
3143         assert_eq!(channel_state.short_to_id.len(), 1);
3144         mem::drop(channel_state);
3145
3146         let mut headers = Vec::new();
3147         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3148         headers.push(header.clone());
3149         for _i in 2..100 {
3150                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3151                 headers.push(header.clone());
3152         }
3153         let mut height = 99;
3154         while !headers.is_empty() {
3155                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3156                 height -= 1;
3157         }
3158         check_closed_broadcast!(nodes[0], false);
3159         check_added_monitors!(nodes[0], 1);
3160         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3161         assert_eq!(channel_state.by_id.len(), 0);
3162         assert_eq!(channel_state.short_to_id.len(), 0);
3163 }
3164
3165 #[test]
3166 fn test_simple_peer_disconnect() {
3167         // Test that we can reconnect when there are no lost messages
3168         let chanmon_cfgs = create_chanmon_cfgs(3);
3169         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3170         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3171         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3172         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3173         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3174
3175         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3176         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3177         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3178
3179         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3180         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3181         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3182         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3183
3184         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3185         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3186         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3187
3188         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3189         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3190         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3191         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3192
3193         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3194         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3195
3196         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3197         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3198
3199         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3200         {
3201                 let events = nodes[0].node.get_and_clear_pending_events();
3202                 assert_eq!(events.len(), 2);
3203                 match events[0] {
3204                         Event::PaymentSent { payment_preimage } => {
3205                                 assert_eq!(payment_preimage, payment_preimage_3);
3206                         },
3207                         _ => panic!("Unexpected event"),
3208                 }
3209                 match events[1] {
3210                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3211                                 assert_eq!(payment_hash, payment_hash_5);
3212                                 assert!(rejected_by_dest);
3213                         },
3214                         _ => panic!("Unexpected event"),
3215                 }
3216         }
3217
3218         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3219         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3220 }
3221
3222 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3223         // Test that we can reconnect when in-flight HTLC updates get dropped
3224         let chanmon_cfgs = create_chanmon_cfgs(2);
3225         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3226         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3227         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3228         if messages_delivered == 0 {
3229                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3230                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3231         } else {
3232                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3233         }
3234
3235         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3236         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3237
3238         let payment_event = {
3239                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3240                 check_added_monitors!(nodes[0], 1);
3241
3242                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3243                 assert_eq!(events.len(), 1);
3244                 SendEvent::from_event(events.remove(0))
3245         };
3246         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3247
3248         if messages_delivered < 2 {
3249                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3250         } else {
3251                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3252                 if messages_delivered >= 3 {
3253                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3254                         check_added_monitors!(nodes[1], 1);
3255                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3256
3257                         if messages_delivered >= 4 {
3258                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3259                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3260                                 check_added_monitors!(nodes[0], 1);
3261
3262                                 if messages_delivered >= 5 {
3263                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3264                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3265                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3266                                         check_added_monitors!(nodes[0], 1);
3267
3268                                         if messages_delivered >= 6 {
3269                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3270                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3271                                                 check_added_monitors!(nodes[1], 1);
3272                                         }
3273                                 }
3274                         }
3275                 }
3276         }
3277
3278         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3279         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3280         if messages_delivered < 3 {
3281                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3282                 // received on either side, both sides will need to resend them.
3283                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3284         } else if messages_delivered == 3 {
3285                 // nodes[0] still wants its RAA + commitment_signed
3286                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3287         } else if messages_delivered == 4 {
3288                 // nodes[0] still wants its commitment_signed
3289                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3290         } else if messages_delivered == 5 {
3291                 // nodes[1] still wants its final RAA
3292                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3293         } else if messages_delivered == 6 {
3294                 // Everything was delivered...
3295                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3296         }
3297
3298         let events_1 = nodes[1].node.get_and_clear_pending_events();
3299         assert_eq!(events_1.len(), 1);
3300         match events_1[0] {
3301                 Event::PendingHTLCsForwardable { .. } => { },
3302                 _ => panic!("Unexpected event"),
3303         };
3304
3305         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3306         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3307         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3308
3309         nodes[1].node.process_pending_htlc_forwards();
3310
3311         let events_2 = nodes[1].node.get_and_clear_pending_events();
3312         assert_eq!(events_2.len(), 1);
3313         match events_2[0] {
3314                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3315                         assert_eq!(payment_hash_1, *payment_hash);
3316                         assert_eq!(*payment_secret, None);
3317                         assert_eq!(amt, 1000000);
3318                 },
3319                 _ => panic!("Unexpected event"),
3320         }
3321
3322         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3323         check_added_monitors!(nodes[1], 1);
3324
3325         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3326         assert_eq!(events_3.len(), 1);
3327         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3328                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3329                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3330                         assert!(updates.update_add_htlcs.is_empty());
3331                         assert!(updates.update_fail_htlcs.is_empty());
3332                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3333                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3334                         assert!(updates.update_fee.is_none());
3335                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3336                 },
3337                 _ => panic!("Unexpected event"),
3338         };
3339
3340         if messages_delivered >= 1 {
3341                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3342
3343                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3344                 assert_eq!(events_4.len(), 1);
3345                 match events_4[0] {
3346                         Event::PaymentSent { ref payment_preimage } => {
3347                                 assert_eq!(payment_preimage_1, *payment_preimage);
3348                         },
3349                         _ => panic!("Unexpected event"),
3350                 }
3351
3352                 if messages_delivered >= 2 {
3353                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3354                         check_added_monitors!(nodes[0], 1);
3355                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3356
3357                         if messages_delivered >= 3 {
3358                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3359                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3360                                 check_added_monitors!(nodes[1], 1);
3361
3362                                 if messages_delivered >= 4 {
3363                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3364                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3365                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3366                                         check_added_monitors!(nodes[1], 1);
3367
3368                                         if messages_delivered >= 5 {
3369                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3370                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3371                                                 check_added_monitors!(nodes[0], 1);
3372                                         }
3373                                 }
3374                         }
3375                 }
3376         }
3377
3378         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3379         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3380         if messages_delivered < 2 {
3381                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3382                 //TODO: Deduplicate PaymentSent events, then enable this if:
3383                 //if messages_delivered < 1 {
3384                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3385                         assert_eq!(events_4.len(), 1);
3386                         match events_4[0] {
3387                                 Event::PaymentSent { ref payment_preimage } => {
3388                                         assert_eq!(payment_preimage_1, *payment_preimage);
3389                                 },
3390                                 _ => panic!("Unexpected event"),
3391                         }
3392                 //}
3393         } else if messages_delivered == 2 {
3394                 // nodes[0] still wants its RAA + commitment_signed
3395                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3396         } else if messages_delivered == 3 {
3397                 // nodes[0] still wants its commitment_signed
3398                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3399         } else if messages_delivered == 4 {
3400                 // nodes[1] still wants its final RAA
3401                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3402         } else if messages_delivered == 5 {
3403                 // Everything was delivered...
3404                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3405         }
3406
3407         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3408         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3409         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3410
3411         // Channel should still work fine...
3412         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3413         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3414 }
3415
3416 #[test]
3417 fn test_drop_messages_peer_disconnect_a() {
3418         do_test_drop_messages_peer_disconnect(0);
3419         do_test_drop_messages_peer_disconnect(1);
3420         do_test_drop_messages_peer_disconnect(2);
3421         do_test_drop_messages_peer_disconnect(3);
3422 }
3423
3424 #[test]
3425 fn test_drop_messages_peer_disconnect_b() {
3426         do_test_drop_messages_peer_disconnect(4);
3427         do_test_drop_messages_peer_disconnect(5);
3428         do_test_drop_messages_peer_disconnect(6);
3429 }
3430
3431 #[test]
3432 fn test_funding_peer_disconnect() {
3433         // Test that we can lock in our funding tx while disconnected
3434         let chanmon_cfgs = create_chanmon_cfgs(2);
3435         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3436         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3437         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3438         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3439
3440         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3441         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3442
3443         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3444         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3445         assert_eq!(events_1.len(), 1);
3446         match events_1[0] {
3447                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3448                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3449                 },
3450                 _ => panic!("Unexpected event"),
3451         }
3452
3453         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3454
3455         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3456         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3457
3458         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3459         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3460         assert_eq!(events_2.len(), 2);
3461         let funding_locked = match events_2[0] {
3462                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3463                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3464                         msg.clone()
3465                 },
3466                 _ => panic!("Unexpected event"),
3467         };
3468         let bs_announcement_sigs = match events_2[1] {
3469                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3470                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3471                         msg.clone()
3472                 },
3473                 _ => panic!("Unexpected event"),
3474         };
3475
3476         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3477
3478         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3479         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3480         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3481         assert_eq!(events_3.len(), 2);
3482         let as_announcement_sigs = match events_3[0] {
3483                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3484                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3485                         msg.clone()
3486                 },
3487                 _ => panic!("Unexpected event"),
3488         };
3489         let (as_announcement, as_update) = match events_3[1] {
3490                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3491                         (msg.clone(), update_msg.clone())
3492                 },
3493                 _ => panic!("Unexpected event"),
3494         };
3495
3496         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3497         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3498         assert_eq!(events_4.len(), 1);
3499         let (_, bs_update) = match events_4[0] {
3500                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3501                         (msg.clone(), update_msg.clone())
3502                 },
3503                 _ => panic!("Unexpected event"),
3504         };
3505
3506         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3507         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3508         nodes[0].router.handle_channel_update(&as_update).unwrap();
3509
3510         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3511         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3512         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3513 }
3514
3515 #[test]
3516 fn test_drop_messages_peer_disconnect_dual_htlc() {
3517         // Test that we can handle reconnecting when both sides of a channel have pending
3518         // commitment_updates when we disconnect.
3519         let chanmon_cfgs = create_chanmon_cfgs(2);
3520         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3521         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3522         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3523         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3524
3525         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3526
3527         // Now try to send a second payment which will fail to send
3528         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3529         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3530
3531         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3532         check_added_monitors!(nodes[0], 1);
3533
3534         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3535         assert_eq!(events_1.len(), 1);
3536         match events_1[0] {
3537                 MessageSendEvent::UpdateHTLCs { .. } => {},
3538                 _ => panic!("Unexpected event"),
3539         }
3540
3541         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3542         check_added_monitors!(nodes[1], 1);
3543
3544         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3545         assert_eq!(events_2.len(), 1);
3546         match events_2[0] {
3547                 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 } } => {
3548                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3549                         assert!(update_add_htlcs.is_empty());
3550                         assert_eq!(update_fulfill_htlcs.len(), 1);
3551                         assert!(update_fail_htlcs.is_empty());
3552                         assert!(update_fail_malformed_htlcs.is_empty());
3553                         assert!(update_fee.is_none());
3554
3555                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3556                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3557                         assert_eq!(events_3.len(), 1);
3558                         match events_3[0] {
3559                                 Event::PaymentSent { ref payment_preimage } => {
3560                                         assert_eq!(*payment_preimage, payment_preimage_1);
3561                                 },
3562                                 _ => panic!("Unexpected event"),
3563                         }
3564
3565                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3566                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3567                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3568                         check_added_monitors!(nodes[0], 1);
3569                 },
3570                 _ => panic!("Unexpected event"),
3571         }
3572
3573         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3574         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3575
3576         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3577         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3578         assert_eq!(reestablish_1.len(), 1);
3579         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3580         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3581         assert_eq!(reestablish_2.len(), 1);
3582
3583         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3584         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3585         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3586         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3587
3588         assert!(as_resp.0.is_none());
3589         assert!(bs_resp.0.is_none());
3590
3591         assert!(bs_resp.1.is_none());
3592         assert!(bs_resp.2.is_none());
3593
3594         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3595
3596         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3597         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3598         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3599         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3600         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3601         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3602         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3603         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3604         // No commitment_signed so get_event_msg's assert(len == 1) passes
3605         check_added_monitors!(nodes[1], 1);
3606
3607         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3608         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3609         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3610         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3611         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3612         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3613         assert!(bs_second_commitment_signed.update_fee.is_none());
3614         check_added_monitors!(nodes[1], 1);
3615
3616         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3617         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3618         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3619         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3620         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3621         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3622         assert!(as_commitment_signed.update_fee.is_none());
3623         check_added_monitors!(nodes[0], 1);
3624
3625         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3626         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3627         // No commitment_signed so get_event_msg's assert(len == 1) passes
3628         check_added_monitors!(nodes[0], 1);
3629
3630         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3631         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3632         // No commitment_signed so get_event_msg's assert(len == 1) passes
3633         check_added_monitors!(nodes[1], 1);
3634
3635         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3636         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3637         check_added_monitors!(nodes[1], 1);
3638
3639         expect_pending_htlcs_forwardable!(nodes[1]);
3640
3641         let events_5 = nodes[1].node.get_and_clear_pending_events();
3642         assert_eq!(events_5.len(), 1);
3643         match events_5[0] {
3644                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3645                         assert_eq!(payment_hash_2, *payment_hash);
3646                         assert_eq!(*payment_secret, None);
3647                 },
3648                 _ => panic!("Unexpected event"),
3649         }
3650
3651         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3652         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3653         check_added_monitors!(nodes[0], 1);
3654
3655         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3656 }
3657
3658 #[test]
3659 fn test_htlc_timeout() {
3660         // If the user fails to claim/fail an HTLC within the HTLC CLTV timeout we fail it for them
3661         // to avoid our counterparty failing the channel.
3662         let chanmon_cfgs = create_chanmon_cfgs(2);
3663         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3664         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3665         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3666
3667         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3668         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 100000);
3669
3670         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3671         nodes[0].block_notifier.block_connected_checked(&header, 101, &[], &[]);
3672         nodes[1].block_notifier.block_connected_checked(&header, 101, &[], &[]);
3673         for i in 102..TEST_FINAL_CLTV + 100 + 1 - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS {
3674                 header.prev_blockhash = header.bitcoin_hash();
3675                 nodes[0].block_notifier.block_connected_checked(&header, i, &[], &[]);
3676                 nodes[1].block_notifier.block_connected_checked(&header, i, &[], &[]);
3677         }
3678
3679         expect_pending_htlcs_forwardable!(nodes[1]);
3680
3681         check_added_monitors!(nodes[1], 1);
3682         let htlc_timeout_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3683         assert!(htlc_timeout_updates.update_add_htlcs.is_empty());
3684         assert_eq!(htlc_timeout_updates.update_fail_htlcs.len(), 1);
3685         assert!(htlc_timeout_updates.update_fail_malformed_htlcs.is_empty());
3686         assert!(htlc_timeout_updates.update_fee.is_none());
3687
3688         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_timeout_updates.update_fail_htlcs[0]);
3689         commitment_signed_dance!(nodes[0], nodes[1], htlc_timeout_updates.commitment_signed, false);
3690         let events = nodes[0].node.get_and_clear_pending_events();
3691         match &events[0] {
3692                 &Event::PaymentFailed { payment_hash, rejected_by_dest, error_code, ref error_data } => {
3693                         assert_eq!(payment_hash, our_payment_hash);
3694                         assert!(rejected_by_dest);
3695                         assert_eq!(error_code.unwrap(), 0x4000 | 15);
3696                         // 100_000 msat as u64, followed by a height of 123 as u32
3697                         assert_eq!(&error_data.as_ref().unwrap()[..], &[
3698                                 ((100_000u64 >> 7*8) & 0xff) as u8,
3699                                 ((100_000u64 >> 6*8) & 0xff) as u8,
3700                                 ((100_000u64 >> 5*8) & 0xff) as u8,
3701                                 ((100_000u64 >> 4*8) & 0xff) as u8,
3702                                 ((100_000u64 >> 3*8) & 0xff) as u8,
3703                                 ((100_000u64 >> 2*8) & 0xff) as u8,
3704                                 ((100_000u64 >> 1*8) & 0xff) as u8,
3705                                 ((100_000u64 >> 0*8) & 0xff) as u8,
3706                                 0, 0, 0, 123]);
3707                 },
3708                 _ => panic!("Unexpected event"),
3709         }
3710 }
3711
3712 #[test]
3713 fn test_invalid_channel_announcement() {
3714         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3715         let secp_ctx = Secp256k1::new();
3716         let chanmon_cfgs = create_chanmon_cfgs(2);
3717         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3718         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3719         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3720
3721         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3722
3723         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3724         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3725         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3726         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3727
3728         nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3729
3730         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3731         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3732
3733         let as_network_key = nodes[0].node.get_our_node_id();
3734         let bs_network_key = nodes[1].node.get_our_node_id();
3735
3736         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3737
3738         let mut chan_announcement;
3739
3740         macro_rules! dummy_unsigned_msg {
3741                 () => {
3742                         msgs::UnsignedChannelAnnouncement {
3743                                 features: ChannelFeatures::supported(),
3744                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3745                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3746                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3747                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3748                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3749                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3750                                 excess_data: Vec::new(),
3751                         };
3752                 }
3753         }
3754
3755         macro_rules! sign_msg {
3756                 ($unsigned_msg: expr) => {
3757                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3758                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key());
3759                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key());
3760                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3761                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3762                         chan_announcement = msgs::ChannelAnnouncement {
3763                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3764                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3765                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3766                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3767                                 contents: $unsigned_msg
3768                         }
3769                 }
3770         }
3771
3772         let unsigned_msg = dummy_unsigned_msg!();
3773         sign_msg!(unsigned_msg);
3774         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3775         let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3776
3777         // Configured with Network::Testnet
3778         let mut unsigned_msg = dummy_unsigned_msg!();
3779         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3780         sign_msg!(unsigned_msg);
3781         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3782
3783         let mut unsigned_msg = dummy_unsigned_msg!();
3784         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3785         sign_msg!(unsigned_msg);
3786         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3787 }
3788
3789 #[test]
3790 fn test_no_txn_manager_serialize_deserialize() {
3791         let chanmon_cfgs = create_chanmon_cfgs(2);
3792         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3793         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3794         let fee_estimator: test_utils::TestFeeEstimator;
3795         let new_chan_monitor: test_utils::TestChannelMonitor;
3796         let keys_manager: test_utils::TestKeysInterface;
3797         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3798         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3799
3800         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3801
3802         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3803
3804         let nodes_0_serialized = nodes[0].node.encode();
3805         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3806         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3807
3808         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3809         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), &fee_estimator);
3810         nodes[0].chan_monitor = &new_chan_monitor;
3811         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3812         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3813         assert!(chan_0_monitor_read.is_empty());
3814
3815         let mut nodes_0_read = &nodes_0_serialized[..];
3816         let config = UserConfig::default();
3817         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3818         let (_, nodes_0_deserialized_tmp) = {
3819                 let mut channel_monitors = HashMap::new();
3820                 channel_monitors.insert(chan_0_monitor.get_funding_txo(), &mut chan_0_monitor);
3821                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3822                         default_config: config,
3823                         keys_manager: &keys_manager,
3824                         fee_estimator: &fee_estimator,
3825                         monitor: nodes[0].chan_monitor,
3826                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3827                         logger: Arc::new(test_utils::TestLogger::new()),
3828                         channel_monitors: &mut channel_monitors,
3829                 }).unwrap()
3830         };
3831         nodes_0_deserialized = nodes_0_deserialized_tmp;
3832         assert!(nodes_0_read.is_empty());
3833
3834         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo(), chan_0_monitor).is_ok());
3835         nodes[0].node = &nodes_0_deserialized;
3836         nodes[0].block_notifier.register_listener(nodes[0].node);
3837         assert_eq!(nodes[0].node.list_channels().len(), 1);
3838         check_added_monitors!(nodes[0], 1);
3839
3840         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3841         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3842         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3843         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3844
3845         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3846         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3847         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3848         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3849
3850         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3851         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3852         for node in nodes.iter() {
3853                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3854                 node.router.handle_channel_update(&as_update).unwrap();
3855                 node.router.handle_channel_update(&bs_update).unwrap();
3856         }
3857
3858         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3859 }
3860
3861 #[test]
3862 fn test_simple_manager_serialize_deserialize() {
3863         let chanmon_cfgs = create_chanmon_cfgs(2);
3864         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3865         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3866         let fee_estimator: test_utils::TestFeeEstimator;
3867         let new_chan_monitor: test_utils::TestChannelMonitor;
3868         let keys_manager: test_utils::TestKeysInterface;
3869         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3870         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3871         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3872
3873         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3874         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3875
3876         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3877
3878         let nodes_0_serialized = nodes[0].node.encode();
3879         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3880         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3881
3882         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3883         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), &fee_estimator);
3884         nodes[0].chan_monitor = &new_chan_monitor;
3885         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3886         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3887         assert!(chan_0_monitor_read.is_empty());
3888
3889         let mut nodes_0_read = &nodes_0_serialized[..];
3890         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3891         let (_, nodes_0_deserialized_tmp) = {
3892                 let mut channel_monitors = HashMap::new();
3893                 channel_monitors.insert(chan_0_monitor.get_funding_txo(), &mut chan_0_monitor);
3894                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3895                         default_config: UserConfig::default(),
3896                         keys_manager: &keys_manager,
3897                         fee_estimator: &fee_estimator,
3898                         monitor: nodes[0].chan_monitor,
3899                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3900                         logger: Arc::new(test_utils::TestLogger::new()),
3901                         channel_monitors: &mut channel_monitors,
3902                 }).unwrap()
3903         };
3904         nodes_0_deserialized = nodes_0_deserialized_tmp;
3905         assert!(nodes_0_read.is_empty());
3906
3907         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo(), chan_0_monitor).is_ok());
3908         nodes[0].node = &nodes_0_deserialized;
3909         check_added_monitors!(nodes[0], 1);
3910
3911         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3912
3913         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3914         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3915 }
3916
3917 #[test]
3918 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3919         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3920         let chanmon_cfgs = create_chanmon_cfgs(4);
3921         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3922         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3923         let fee_estimator: test_utils::TestFeeEstimator;
3924         let new_chan_monitor: test_utils::TestChannelMonitor;
3925         let keys_manager: test_utils::TestKeysInterface;
3926         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3927         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3928         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3929         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3930         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3931
3932         let mut node_0_stale_monitors_serialized = Vec::new();
3933         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3934                 let mut writer = test_utils::TestVecWriter(Vec::new());
3935                 monitor.1.write_for_disk(&mut writer).unwrap();
3936                 node_0_stale_monitors_serialized.push(writer.0);
3937         }
3938
3939         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3940
3941         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3942         let nodes_0_serialized = nodes[0].node.encode();
3943
3944         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3945         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3946         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3947         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3948
3949         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3950         // nodes[3])
3951         let mut node_0_monitors_serialized = Vec::new();
3952         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3953                 let mut writer = test_utils::TestVecWriter(Vec::new());
3954                 monitor.1.write_for_disk(&mut writer).unwrap();
3955                 node_0_monitors_serialized.push(writer.0);
3956         }
3957
3958         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3959         new_chan_monitor = test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), &fee_estimator);
3960         nodes[0].chan_monitor = &new_chan_monitor;
3961
3962         let mut node_0_stale_monitors = Vec::new();
3963         for serialized in node_0_stale_monitors_serialized.iter() {
3964                 let mut read = &serialized[..];
3965                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3966                 assert!(read.is_empty());
3967                 node_0_stale_monitors.push(monitor);
3968         }
3969
3970         let mut node_0_monitors = Vec::new();
3971         for serialized in node_0_monitors_serialized.iter() {
3972                 let mut read = &serialized[..];
3973                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3974                 assert!(read.is_empty());
3975                 node_0_monitors.push(monitor);
3976         }
3977
3978         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3979
3980         let mut nodes_0_read = &nodes_0_serialized[..];
3981         if let Err(msgs::DecodeError::InvalidValue) =
3982                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3983                 default_config: UserConfig::default(),
3984                 keys_manager: &keys_manager,
3985                 fee_estimator: &fee_estimator,
3986                 monitor: nodes[0].chan_monitor,
3987                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3988                 logger: Arc::new(test_utils::TestLogger::new()),
3989                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo(), monitor) }).collect(),
3990         }) { } else {
3991                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
3992         };
3993
3994         let mut nodes_0_read = &nodes_0_serialized[..];
3995         let (_, nodes_0_deserialized_tmp) =
3996                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3997                 default_config: UserConfig::default(),
3998                 keys_manager: &keys_manager,
3999                 fee_estimator: &fee_estimator,
4000                 monitor: nodes[0].chan_monitor,
4001                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
4002                 logger: Arc::new(test_utils::TestLogger::new()),
4003                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo(), monitor) }).collect(),
4004         }).unwrap();
4005         nodes_0_deserialized = nodes_0_deserialized_tmp;
4006         assert!(nodes_0_read.is_empty());
4007
4008         { // Channel close should result in a commitment tx and an HTLC tx
4009                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4010                 assert_eq!(txn.len(), 2);
4011                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
4012                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
4013         }
4014
4015         for monitor in node_0_monitors.drain(..) {
4016                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo(), monitor).is_ok());
4017                 check_added_monitors!(nodes[0], 1);
4018         }
4019         nodes[0].node = &nodes_0_deserialized;
4020
4021         // nodes[1] and nodes[2] have no lost state with nodes[0]...
4022         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4023         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4024         //... and we can even still claim the payment!
4025         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
4026
4027         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4028         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4029         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4030         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4031         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4032         assert_eq!(msg_events.len(), 1);
4033         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4034                 match action {
4035                         &ErrorAction::SendErrorMessage { ref msg } => {
4036                                 assert_eq!(msg.channel_id, channel_id);
4037                         },
4038                         _ => panic!("Unexpected event!"),
4039                 }
4040         }
4041 }
4042
4043 macro_rules! check_spendable_outputs {
4044         ($node: expr, $der_idx: expr) => {
4045                 {
4046                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
4047                         let mut txn = Vec::new();
4048                         for event in events {
4049                                 match event {
4050                                         Event::SpendableOutputs { ref outputs } => {
4051                                                 for outp in outputs {
4052                                                         match *outp {
4053                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
4054                                                                         let input = TxIn {
4055                                                                                 previous_output: outpoint.clone(),
4056                                                                                 script_sig: Script::new(),
4057                                                                                 sequence: 0,
4058                                                                                 witness: Vec::new(),
4059                                                                         };
4060                                                                         let outp = TxOut {
4061                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4062                                                                                 value: output.value,
4063                                                                         };
4064                                                                         let mut spend_tx = Transaction {
4065                                                                                 version: 2,
4066                                                                                 lock_time: 0,
4067                                                                                 input: vec![input],
4068                                                                                 output: vec![outp],
4069                                                                         };
4070                                                                         let secp_ctx = Secp256k1::new();
4071                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
4072                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4073                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4074                                                                         let remotesig = secp_ctx.sign(&sighash, key);
4075                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4076                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4077                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4078                                                                         txn.push(spend_tx);
4079                                                                 },
4080                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
4081                                                                         let input = TxIn {
4082                                                                                 previous_output: outpoint.clone(),
4083                                                                                 script_sig: Script::new(),
4084                                                                                 sequence: *to_self_delay as u32,
4085                                                                                 witness: Vec::new(),
4086                                                                         };
4087                                                                         let outp = TxOut {
4088                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4089                                                                                 value: output.value,
4090                                                                         };
4091                                                                         let mut spend_tx = Transaction {
4092                                                                                 version: 2,
4093                                                                                 lock_time: 0,
4094                                                                                 input: vec![input],
4095                                                                                 output: vec![outp],
4096                                                                         };
4097                                                                         let secp_ctx = Secp256k1::new();
4098                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
4099                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
4100                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
4101                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4102                                                                         spend_tx.input[0].witness.push(vec!());
4103                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4104                                                                         txn.push(spend_tx);
4105                                                                 },
4106                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4107                                                                         let secp_ctx = Secp256k1::new();
4108                                                                         let input = TxIn {
4109                                                                                 previous_output: outpoint.clone(),
4110                                                                                 script_sig: Script::new(),
4111                                                                                 sequence: 0,
4112                                                                                 witness: Vec::new(),
4113                                                                         };
4114                                                                         let outp = TxOut {
4115                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4116                                                                                 value: output.value,
4117                                                                         };
4118                                                                         let mut spend_tx = Transaction {
4119                                                                                 version: 2,
4120                                                                                 lock_time: 0,
4121                                                                                 input: vec![input],
4122                                                                                 output: vec![outp.clone()],
4123                                                                         };
4124                                                                         let secret = {
4125                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4126                                                                                         Ok(master_key) => {
4127                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4128                                                                                                         Ok(key) => key,
4129                                                                                                         Err(_) => panic!("Your RNG is busted"),
4130                                                                                                 }
4131                                                                                         }
4132                                                                                         Err(_) => panic!("Your rng is busted"),
4133                                                                                 }
4134                                                                         };
4135                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4136                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4137                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4138                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4139                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4140                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4141                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4142                                                                         txn.push(spend_tx);
4143                                                                 },
4144                                                         }
4145                                                 }
4146                                         },
4147                                         _ => panic!("Unexpected event"),
4148                                 };
4149                         }
4150                         txn
4151                 }
4152         }
4153 }
4154
4155 #[test]
4156 fn test_claim_sizeable_push_msat() {
4157         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4158         let chanmon_cfgs = create_chanmon_cfgs(2);
4159         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4160         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4161         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4162
4163         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4164         nodes[1].node.force_close_channel(&chan.2);
4165         check_closed_broadcast!(nodes[1], false);
4166         check_added_monitors!(nodes[1], 1);
4167         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4168         assert_eq!(node_txn.len(), 1);
4169         check_spends!(node_txn[0], chan.3);
4170         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
4171
4172         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4173         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4174         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4175
4176         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4177         assert_eq!(spend_txn.len(), 1);
4178         check_spends!(spend_txn[0], node_txn[0]);
4179 }
4180
4181 #[test]
4182 fn test_claim_on_remote_sizeable_push_msat() {
4183         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4184         // to_remote output is encumbered by a P2WPKH
4185         let chanmon_cfgs = create_chanmon_cfgs(2);
4186         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4187         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4188         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4189
4190         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4191         nodes[0].node.force_close_channel(&chan.2);
4192         check_closed_broadcast!(nodes[0], false);
4193         check_added_monitors!(nodes[0], 1);
4194
4195         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4196         assert_eq!(node_txn.len(), 1);
4197         check_spends!(node_txn[0], chan.3);
4198         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
4199
4200         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4201         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4202         check_closed_broadcast!(nodes[1], false);
4203         check_added_monitors!(nodes[1], 1);
4204         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4205
4206         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4207         assert_eq!(spend_txn.len(), 2);
4208         assert_eq!(spend_txn[0], spend_txn[1]);
4209         check_spends!(spend_txn[0], node_txn[0]);
4210 }
4211
4212 #[test]
4213 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4214         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4215         // to_remote output is encumbered by a P2WPKH
4216
4217         let chanmon_cfgs = create_chanmon_cfgs(2);
4218         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4219         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4220         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4221
4222         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
4223         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4224         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4225         assert_eq!(revoked_local_txn[0].input.len(), 1);
4226         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4227
4228         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4229         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4230         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4231         check_closed_broadcast!(nodes[1], false);
4232         check_added_monitors!(nodes[1], 1);
4233
4234         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4235         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4236         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4237         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4238
4239         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4240         assert_eq!(spend_txn.len(), 3);
4241         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4242         check_spends!(spend_txn[0], revoked_local_txn[0]);
4243         check_spends!(spend_txn[2], node_txn[0]);
4244 }
4245
4246 #[test]
4247 fn test_static_spendable_outputs_preimage_tx() {
4248         let chanmon_cfgs = create_chanmon_cfgs(2);
4249         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4250         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4251         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4252
4253         // Create some initial channels
4254         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4255
4256         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4257
4258         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4259         assert_eq!(commitment_tx[0].input.len(), 1);
4260         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4261
4262         // Settle A's commitment tx on B's chain
4263         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4264         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4265         check_added_monitors!(nodes[1], 1);
4266         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4267         check_added_monitors!(nodes[1], 1);
4268         let events = nodes[1].node.get_and_clear_pending_msg_events();
4269         match events[0] {
4270                 MessageSendEvent::UpdateHTLCs { .. } => {},
4271                 _ => panic!("Unexpected event"),
4272         }
4273         match events[1] {
4274                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4275                 _ => panic!("Unexepected event"),
4276         }
4277
4278         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4279         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4280         assert_eq!(node_txn.len(), 3);
4281         check_spends!(node_txn[0], commitment_tx[0]);
4282         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4283         check_spends!(node_txn[1], chan_1.3);
4284         check_spends!(node_txn[2], node_txn[1]);
4285
4286         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4287         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4288         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4289
4290         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4291         assert_eq!(spend_txn.len(), 1);
4292         check_spends!(spend_txn[0], node_txn[0]);
4293 }
4294
4295 #[test]
4296 fn test_static_spendable_outputs_timeout_tx() {
4297         let chanmon_cfgs = create_chanmon_cfgs(2);
4298         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4299         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4300         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4301
4302         // Create some initial channels
4303         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4304
4305         // Rebalance the network a bit by relaying one payment through all the channels ...
4306         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4307
4308         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4309
4310         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4311         assert_eq!(commitment_tx[0].input.len(), 1);
4312         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4313
4314         // Settle A's commitment tx on B' chain
4315         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4316         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4317         check_added_monitors!(nodes[1], 1);
4318         let events = nodes[1].node.get_and_clear_pending_msg_events();
4319         match events[0] {
4320                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4321                 _ => panic!("Unexpected event"),
4322         }
4323
4324         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4325         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4326         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4327         check_spends!(node_txn[0],  commitment_tx[0].clone());
4328         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4329         check_spends!(node_txn[1], chan_1.3.clone());
4330         check_spends!(node_txn[2], node_txn[1]);
4331
4332         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4333         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4334         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4335         let events = nodes[1].node.get_and_clear_pending_events();
4336         assert_eq!(events.len(), 1);
4337         match events[0] {
4338                 Event::PaymentFailed { payment_hash, .. } => {
4339                         assert_eq!(payment_hash, our_payment_hash);
4340                 },
4341                 _ => panic!("Unexpected event"),
4342         }
4343
4344         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4345         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4346         check_spends!(spend_txn[2], node_txn[0].clone());
4347 }
4348
4349 #[test]
4350 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4351         let chanmon_cfgs = create_chanmon_cfgs(2);
4352         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4353         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4354         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4355
4356         // Create some initial channels
4357         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4358
4359         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4360         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4361         assert_eq!(revoked_local_txn[0].input.len(), 1);
4362         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4363
4364         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4365
4366         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4367         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4368         check_closed_broadcast!(nodes[1], false);
4369         check_added_monitors!(nodes[1], 1);
4370
4371         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4372         assert_eq!(node_txn.len(), 2);
4373         assert_eq!(node_txn[0].input.len(), 2);
4374         check_spends!(node_txn[0], revoked_local_txn[0]);
4375
4376         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4377         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4378         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4379
4380         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4381         assert_eq!(spend_txn.len(), 1);
4382         check_spends!(spend_txn[0], node_txn[0]);
4383 }
4384
4385 #[test]
4386 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4387         let chanmon_cfgs = create_chanmon_cfgs(2);
4388         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4389         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4390         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4391
4392         // Create some initial channels
4393         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4394
4395         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4396         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4397         assert_eq!(revoked_local_txn[0].input.len(), 1);
4398         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4399
4400         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4401
4402         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4403         // A will generate HTLC-Timeout from revoked commitment tx
4404         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4405         check_closed_broadcast!(nodes[0], false);
4406         check_added_monitors!(nodes[0], 1);
4407
4408         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4409         assert_eq!(revoked_htlc_txn.len(), 2);
4410         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4411         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4412         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4413         check_spends!(revoked_htlc_txn[1], chan_1.3);
4414
4415         // B will generate justice tx from A's revoked commitment/HTLC tx
4416         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4417         check_closed_broadcast!(nodes[1], false);
4418         check_added_monitors!(nodes[1], 1);
4419
4420         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4421         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
4422         assert_eq!(node_txn[0].input.len(), 2);
4423         check_spends!(node_txn[0], revoked_local_txn[0]);
4424         check_spends!(node_txn[1], chan_1.3);
4425         assert_eq!(node_txn[2].input.len(), 1);
4426         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4427         assert_eq!(node_txn[3].input.len(), 1);
4428         check_spends!(node_txn[3], revoked_local_txn[0]);
4429
4430         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4431         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4432         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4433
4434         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4435         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4436         assert_eq!(spend_txn.len(), 2);
4437         check_spends!(spend_txn[0], node_txn[0]);
4438         check_spends!(spend_txn[1], node_txn[2]);
4439 }
4440
4441 #[test]
4442 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4443         let chanmon_cfgs = create_chanmon_cfgs(2);
4444         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4445         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4446         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4447
4448         // Create some initial channels
4449         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4450
4451         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4452         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4453         assert_eq!(revoked_local_txn[0].input.len(), 1);
4454         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4455
4456         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4457
4458         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4459         // B will generate HTLC-Success from revoked commitment tx
4460         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4461         check_closed_broadcast!(nodes[1], false);
4462         check_added_monitors!(nodes[1], 1);
4463         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4464
4465         assert_eq!(revoked_htlc_txn.len(), 2);
4466         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4467         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4468         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4469
4470         // A will generate justice tx from B's revoked commitment/HTLC tx
4471         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4472         check_closed_broadcast!(nodes[0], false);
4473         check_added_monitors!(nodes[0], 1);
4474
4475         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4476         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4477         assert_eq!(node_txn[2].input.len(), 1);
4478         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4479
4480         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4481         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4482         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4483
4484         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4485         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4486         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
4487         assert_eq!(spend_txn[0], spend_txn[1]);
4488         assert_eq!(spend_txn[0], spend_txn[2]);
4489         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4490         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
4491         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
4492 }
4493
4494 #[test]
4495 fn test_onchain_to_onchain_claim() {
4496         // Test that in case of channel closure, we detect the state of output thanks to
4497         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4498         // First, have C claim an HTLC against its own latest commitment transaction.
4499         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4500         // channel.
4501         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4502         // gets broadcast.
4503
4504         let chanmon_cfgs = create_chanmon_cfgs(3);
4505         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4506         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4507         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4508
4509         // Create some initial channels
4510         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4511         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4512
4513         // Rebalance the network a bit by relaying one payment through all the channels ...
4514         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4515         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4516
4517         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4518         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4519         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4520         check_spends!(commitment_tx[0], chan_2.3);
4521         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
4522         check_added_monitors!(nodes[2], 1);
4523         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4524         assert!(updates.update_add_htlcs.is_empty());
4525         assert!(updates.update_fail_htlcs.is_empty());
4526         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4527         assert!(updates.update_fail_malformed_htlcs.is_empty());
4528
4529         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4530         check_closed_broadcast!(nodes[2], false);
4531         check_added_monitors!(nodes[2], 1);
4532
4533         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4534         assert_eq!(c_txn.len(), 3);
4535         assert_eq!(c_txn[0], c_txn[2]);
4536         assert_eq!(commitment_tx[0], c_txn[1]);
4537         check_spends!(c_txn[1], chan_2.3);
4538         check_spends!(c_txn[2], c_txn[1]);
4539         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4540         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4541         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4542         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4543
4544         // 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
4545         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4546         {
4547                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4548                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4549                 assert_eq!(b_txn.len(), 3);
4550                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4551                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4552                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4553                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4554                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4555                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4556                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4557                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4558                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4559                 b_txn.clear();
4560         }
4561         check_added_monitors!(nodes[1], 1);
4562         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4563         check_added_monitors!(nodes[1], 1);
4564         match msg_events[0] {
4565                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4566                 _ => panic!("Unexpected event"),
4567         }
4568         match msg_events[1] {
4569                 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, .. } } => {
4570                         assert!(update_add_htlcs.is_empty());
4571                         assert!(update_fail_htlcs.is_empty());
4572                         assert_eq!(update_fulfill_htlcs.len(), 1);
4573                         assert!(update_fail_malformed_htlcs.is_empty());
4574                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4575                 },
4576                 _ => panic!("Unexpected event"),
4577         };
4578         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4579         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4580         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4581         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4582         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4583         assert_eq!(b_txn.len(), 3);
4584         check_spends!(b_txn[1], chan_1.3);
4585         check_spends!(b_txn[2], b_txn[1]);
4586         check_spends!(b_txn[0], commitment_tx[0]);
4587         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4588         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4589         assert_eq!(b_txn[0].lock_time, 0); // Success tx
4590
4591         check_closed_broadcast!(nodes[1], false);
4592         check_added_monitors!(nodes[1], 1);
4593 }
4594
4595 #[test]
4596 fn test_duplicate_payment_hash_one_failure_one_success() {
4597         // Topology : A --> B --> C
4598         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4599         let chanmon_cfgs = create_chanmon_cfgs(3);
4600         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4601         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4602         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4603
4604         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4605         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4606
4607         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4608         *nodes[0].network_payment_count.borrow_mut() -= 1;
4609         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4610
4611         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
4612         assert_eq!(commitment_txn[0].input.len(), 1);
4613         check_spends!(commitment_txn[0], chan_2.3);
4614
4615         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4616         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4617         check_closed_broadcast!(nodes[1], false);
4618         check_added_monitors!(nodes[1], 1);
4619
4620         let htlc_timeout_tx;
4621         { // Extract one of the two HTLC-Timeout transaction
4622                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4623                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
4624                 assert_eq!(node_txn.len(), 5);
4625                 check_spends!(node_txn[0], commitment_txn[0]);
4626                 assert_eq!(node_txn[0].input.len(), 1);
4627                 check_spends!(node_txn[1], commitment_txn[0]);
4628                 assert_eq!(node_txn[1].input.len(), 1);
4629                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4630                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4631                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4632                 check_spends!(node_txn[2], chan_2.3);
4633                 check_spends!(node_txn[3], node_txn[2]);
4634                 check_spends!(node_txn[4], node_txn[2]);
4635                 htlc_timeout_tx = node_txn[1].clone();
4636         }
4637
4638         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
4639         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4640         check_added_monitors!(nodes[2], 3);
4641         let events = nodes[2].node.get_and_clear_pending_msg_events();
4642         match events[0] {
4643                 MessageSendEvent::UpdateHTLCs { .. } => {},
4644                 _ => panic!("Unexpected event"),
4645         }
4646         match events[1] {
4647                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4648                 _ => panic!("Unexepected event"),
4649         }
4650         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4651         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)
4652         check_spends!(htlc_success_txn[2], chan_2.3);
4653         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4654         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4655         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
4656         assert_eq!(htlc_success_txn[0].input.len(), 1);
4657         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4658         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4659         assert_eq!(htlc_success_txn[1].input.len(), 1);
4660         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4661         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4662         check_spends!(htlc_success_txn[0], commitment_txn[0]);
4663         check_spends!(htlc_success_txn[1], commitment_txn[0]);
4664
4665         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4666         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4667         expect_pending_htlcs_forwardable!(nodes[1]);
4668         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4669         assert!(htlc_updates.update_add_htlcs.is_empty());
4670         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4671         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4672         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4673         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4674         check_added_monitors!(nodes[1], 1);
4675
4676         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4677         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4678         {
4679                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4680                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4681                 assert_eq!(events.len(), 1);
4682                 match events[0] {
4683                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4684                         },
4685                         _ => { panic!("Unexpected event"); }
4686                 }
4687         }
4688         let events = nodes[0].node.get_and_clear_pending_events();
4689         match events[0] {
4690                 Event::PaymentFailed { ref payment_hash, .. } => {
4691                         assert_eq!(*payment_hash, duplicate_payment_hash);
4692                 }
4693                 _ => panic!("Unexpected event"),
4694         }
4695
4696         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4697         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4698         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4699         assert!(updates.update_add_htlcs.is_empty());
4700         assert!(updates.update_fail_htlcs.is_empty());
4701         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4702         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4703         assert!(updates.update_fail_malformed_htlcs.is_empty());
4704         check_added_monitors!(nodes[1], 1);
4705
4706         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4707         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4708
4709         let events = nodes[0].node.get_and_clear_pending_events();
4710         match events[0] {
4711                 Event::PaymentSent { ref payment_preimage } => {
4712                         assert_eq!(*payment_preimage, our_payment_preimage);
4713                 }
4714                 _ => panic!("Unexpected event"),
4715         }
4716 }
4717
4718 #[test]
4719 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4720         let chanmon_cfgs = create_chanmon_cfgs(2);
4721         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4722         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4723         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4724
4725         // Create some initial channels
4726         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4727
4728         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4729         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4730         assert_eq!(local_txn[0].input.len(), 1);
4731         check_spends!(local_txn[0], chan_1.3);
4732
4733         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4734         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
4735         check_added_monitors!(nodes[1], 1);
4736         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4737         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4738         check_added_monitors!(nodes[1], 1);
4739         let events = nodes[1].node.get_and_clear_pending_msg_events();
4740         match events[0] {
4741                 MessageSendEvent::UpdateHTLCs { .. } => {},
4742                 _ => panic!("Unexpected event"),
4743         }
4744         match events[1] {
4745                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4746                 _ => panic!("Unexepected event"),
4747         }
4748         let node_txn = {
4749                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4750                 assert_eq!(node_txn[0].input.len(), 1);
4751                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4752                 check_spends!(node_txn[0], local_txn[0]);
4753                 vec![node_txn[0].clone(), node_txn[2].clone()]
4754         };
4755
4756         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4757         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
4758         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
4759
4760         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4761         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4762         assert_eq!(spend_txn.len(), 2);
4763         check_spends!(spend_txn[0], node_txn[0]);
4764         check_spends!(spend_txn[1], node_txn[1]);
4765 }
4766
4767 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4768         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4769         // unrevoked commitment transaction.
4770         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4771         // a remote RAA before they could be failed backwards (and combinations thereof).
4772         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4773         // use the same payment hashes.
4774         // Thus, we use a six-node network:
4775         //
4776         // A \         / E
4777         //    - C - D -
4778         // B /         \ F
4779         // And test where C fails back to A/B when D announces its latest commitment transaction
4780         let chanmon_cfgs = create_chanmon_cfgs(6);
4781         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4782         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4783         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4784
4785         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4786         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4787         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4788         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4789         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4790
4791         // Rebalance and check output sanity...
4792         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4793         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4794         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
4795
4796         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4797         // 0th HTLC:
4798         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
4799         // 1st HTLC:
4800         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
4801         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV).unwrap();
4802         // 2nd HTLC:
4803         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
4804         // 3rd HTLC:
4805         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
4806         // 4th HTLC:
4807         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4808         // 5th HTLC:
4809         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4810         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4811         // 6th HTLC:
4812         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4813         // 7th HTLC:
4814         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4815
4816         // 8th HTLC:
4817         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4818         // 9th HTLC:
4819         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), ds_dust_limit*1000, TEST_FINAL_CLTV).unwrap();
4820         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
4821
4822         // 10th HTLC:
4823         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
4824         // 11th HTLC:
4825         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4826         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4827
4828         // Double-check that six of the new HTLC were added
4829         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4830         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4831         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
4832         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
4833
4834         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4835         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4836         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
4837         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
4838         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
4839         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
4840         check_added_monitors!(nodes[4], 0);
4841         expect_pending_htlcs_forwardable!(nodes[4]);
4842         check_added_monitors!(nodes[4], 1);
4843
4844         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4845         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4846         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4847         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4848         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4849         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4850
4851         // Fail 3rd below-dust and 7th above-dust HTLCs
4852         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
4853         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
4854         check_added_monitors!(nodes[5], 0);
4855         expect_pending_htlcs_forwardable!(nodes[5]);
4856         check_added_monitors!(nodes[5], 1);
4857
4858         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4859         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4860         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4861         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4862
4863         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4864
4865         expect_pending_htlcs_forwardable!(nodes[3]);
4866         check_added_monitors!(nodes[3], 1);
4867         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4868         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4869         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4870         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4871         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4872         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4873         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4874         if deliver_last_raa {
4875                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4876         } else {
4877                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4878         }
4879
4880         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4881         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4882         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4883         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4884         //
4885         // We now broadcast the latest commitment transaction, which *should* result in failures for
4886         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4887         // the non-broadcast above-dust HTLCs.
4888         //
4889         // Alternatively, we may broadcast the previous commitment transaction, which should only
4890         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4891         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4892
4893         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4894         if announce_latest {
4895                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4896         } else {
4897                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4898         }
4899         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4900         check_closed_broadcast!(nodes[2], false);
4901         expect_pending_htlcs_forwardable!(nodes[2]);
4902         check_added_monitors!(nodes[2], 3);
4903
4904         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4905         assert_eq!(cs_msgs.len(), 2);
4906         let mut a_done = false;
4907         for msg in cs_msgs {
4908                 match msg {
4909                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4910                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4911                                 // should be failed-backwards here.
4912                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4913                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4914                                         for htlc in &updates.update_fail_htlcs {
4915                                                 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 });
4916                                         }
4917                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4918                                         assert!(!a_done);
4919                                         a_done = true;
4920                                         &nodes[0]
4921                                 } else {
4922                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4923                                         for htlc in &updates.update_fail_htlcs {
4924                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4925                                         }
4926                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4927                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4928                                         &nodes[1]
4929                                 };
4930                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4931                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4932                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4933                                 if announce_latest {
4934                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4935                                         if *node_id == nodes[0].node.get_our_node_id() {
4936                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4937                                         }
4938                                 }
4939                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4940                         },
4941                         _ => panic!("Unexpected event"),
4942                 }
4943         }
4944
4945         let as_events = nodes[0].node.get_and_clear_pending_events();
4946         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4947         let mut as_failds = HashSet::new();
4948         for event in as_events.iter() {
4949                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4950                         assert!(as_failds.insert(*payment_hash));
4951                         if *payment_hash != payment_hash_2 {
4952                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4953                         } else {
4954                                 assert!(!rejected_by_dest);
4955                         }
4956                 } else { panic!("Unexpected event"); }
4957         }
4958         assert!(as_failds.contains(&payment_hash_1));
4959         assert!(as_failds.contains(&payment_hash_2));
4960         if announce_latest {
4961                 assert!(as_failds.contains(&payment_hash_3));
4962                 assert!(as_failds.contains(&payment_hash_5));
4963         }
4964         assert!(as_failds.contains(&payment_hash_6));
4965
4966         let bs_events = nodes[1].node.get_and_clear_pending_events();
4967         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4968         let mut bs_failds = HashSet::new();
4969         for event in bs_events.iter() {
4970                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4971                         assert!(bs_failds.insert(*payment_hash));
4972                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4973                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4974                         } else {
4975                                 assert!(!rejected_by_dest);
4976                         }
4977                 } else { panic!("Unexpected event"); }
4978         }
4979         assert!(bs_failds.contains(&payment_hash_1));
4980         assert!(bs_failds.contains(&payment_hash_2));
4981         if announce_latest {
4982                 assert!(bs_failds.contains(&payment_hash_4));
4983         }
4984         assert!(bs_failds.contains(&payment_hash_5));
4985
4986         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4987         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4988         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4989         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4990         // PaymentFailureNetworkUpdates.
4991         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4992         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4993         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4994         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4995         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4996                 match event {
4997                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4998                         _ => panic!("Unexpected event"),
4999                 }
5000         }
5001 }
5002
5003 #[test]
5004 fn test_fail_backwards_latest_remote_announce_a() {
5005         do_test_fail_backwards_unrevoked_remote_announce(false, true);
5006 }
5007
5008 #[test]
5009 fn test_fail_backwards_latest_remote_announce_b() {
5010         do_test_fail_backwards_unrevoked_remote_announce(true, true);
5011 }
5012
5013 #[test]
5014 fn test_fail_backwards_previous_remote_announce() {
5015         do_test_fail_backwards_unrevoked_remote_announce(false, false);
5016         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
5017         // tested for in test_commitment_revoked_fail_backward_exhaustive()
5018 }
5019
5020 #[test]
5021 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
5022         let chanmon_cfgs = create_chanmon_cfgs(2);
5023         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5024         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5025         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5026
5027         // Create some initial channels
5028         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5029
5030         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5031         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5032         assert_eq!(local_txn[0].input.len(), 1);
5033         check_spends!(local_txn[0], chan_1.3);
5034
5035         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5036         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5037         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5038         check_closed_broadcast!(nodes[0], false);
5039         check_added_monitors!(nodes[0], 1);
5040
5041         let htlc_timeout = {
5042                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5043                 assert_eq!(node_txn[0].input.len(), 1);
5044                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5045                 check_spends!(node_txn[0], local_txn[0]);
5046                 node_txn[0].clone()
5047         };
5048
5049         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5050         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5051         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5052         let events = nodes[0].node.get_and_clear_pending_events();
5053         assert_eq!(events.len(), 1);
5054         match events[0] {
5055                 Event::PaymentFailed { payment_hash, .. } => {
5056                         assert_eq!(payment_hash, our_payment_hash);
5057                 },
5058                 _ => panic!("Unexpected event"),
5059         }
5060
5061         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5062         let spend_txn = check_spendable_outputs!(nodes[0], 1);
5063         assert_eq!(spend_txn.len(), 3);
5064         assert_eq!(spend_txn[0], spend_txn[1]);
5065         check_spends!(spend_txn[0], local_txn[0]);
5066         check_spends!(spend_txn[2], htlc_timeout);
5067 }
5068
5069 #[test]
5070 fn test_static_output_closing_tx() {
5071         let chanmon_cfgs = create_chanmon_cfgs(2);
5072         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5073         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5074         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5075
5076         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5077
5078         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5079         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5080
5081         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5082         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5083         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5084
5085         let spend_txn = check_spendable_outputs!(nodes[0], 2);
5086         assert_eq!(spend_txn.len(), 1);
5087         check_spends!(spend_txn[0], closing_tx);
5088
5089         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5090         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5091
5092         let spend_txn = check_spendable_outputs!(nodes[1], 2);
5093         assert_eq!(spend_txn.len(), 1);
5094         check_spends!(spend_txn[0], closing_tx);
5095 }
5096
5097 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5098         let chanmon_cfgs = create_chanmon_cfgs(2);
5099         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5100         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5101         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5102         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5103
5104         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5105
5106         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5107         // present in B's local commitment transaction, but none of A's commitment transactions.
5108         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5109         check_added_monitors!(nodes[1], 1);
5110
5111         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5112         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5113         let events = nodes[0].node.get_and_clear_pending_events();
5114         assert_eq!(events.len(), 1);
5115         match events[0] {
5116                 Event::PaymentSent { payment_preimage } => {
5117                         assert_eq!(payment_preimage, our_payment_preimage);
5118                 },
5119                 _ => panic!("Unexpected event"),
5120         }
5121
5122         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5123         check_added_monitors!(nodes[0], 1);
5124         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5125         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5126         check_added_monitors!(nodes[1], 1);
5127
5128         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5129         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5130                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5131                 header.prev_blockhash = header.bitcoin_hash();
5132         }
5133         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5134         check_closed_broadcast!(nodes[1], false);
5135         check_added_monitors!(nodes[1], 1);
5136 }
5137
5138 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5139         let chanmon_cfgs = create_chanmon_cfgs(2);
5140         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5141         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5142         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5143         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5144
5145         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), if use_dust { 50000 } else { 3000000 }, TEST_FINAL_CLTV).unwrap();
5146         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5147         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5148         check_added_monitors!(nodes[0], 1);
5149
5150         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5151
5152         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5153         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5154         // to "time out" the HTLC.
5155
5156         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5157
5158         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5159                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5160                 header.prev_blockhash = header.bitcoin_hash();
5161         }
5162         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5163         check_closed_broadcast!(nodes[0], false);
5164         check_added_monitors!(nodes[0], 1);
5165 }
5166
5167 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5168         let chanmon_cfgs = create_chanmon_cfgs(3);
5169         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5170         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5171         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5172         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5173
5174         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5175         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5176         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5177         // actually revoked.
5178         let htlc_value = if use_dust { 50000 } else { 3000000 };
5179         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5180         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5181         expect_pending_htlcs_forwardable!(nodes[1]);
5182         check_added_monitors!(nodes[1], 1);
5183
5184         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5185         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5186         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5187         check_added_monitors!(nodes[0], 1);
5188         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5189         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5190         check_added_monitors!(nodes[1], 1);
5191         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5192         check_added_monitors!(nodes[1], 1);
5193         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5194
5195         if check_revoke_no_close {
5196                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5197                 check_added_monitors!(nodes[0], 1);
5198         }
5199
5200         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5201         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5202                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5203                 header.prev_blockhash = header.bitcoin_hash();
5204         }
5205         if !check_revoke_no_close {
5206                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5207                 check_closed_broadcast!(nodes[0], false);
5208                 check_added_monitors!(nodes[0], 1);
5209         } else {
5210                 let events = nodes[0].node.get_and_clear_pending_events();
5211                 assert_eq!(events.len(), 1);
5212                 match events[0] {
5213                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
5214                                 assert_eq!(payment_hash, our_payment_hash);
5215                                 assert!(rejected_by_dest);
5216                         },
5217                         _ => panic!("Unexpected event"),
5218                 }
5219         }
5220 }
5221
5222 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5223 // There are only a few cases to test here:
5224 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5225 //    broadcastable commitment transactions result in channel closure,
5226 //  * its included in an unrevoked-but-previous remote commitment transaction,
5227 //  * its included in the latest remote or local commitment transactions.
5228 // We test each of the three possible commitment transactions individually and use both dust and
5229 // non-dust HTLCs.
5230 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5231 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5232 // tested for at least one of the cases in other tests.
5233 #[test]
5234 fn htlc_claim_single_commitment_only_a() {
5235         do_htlc_claim_local_commitment_only(true);
5236         do_htlc_claim_local_commitment_only(false);
5237
5238         do_htlc_claim_current_remote_commitment_only(true);
5239         do_htlc_claim_current_remote_commitment_only(false);
5240 }
5241
5242 #[test]
5243 fn htlc_claim_single_commitment_only_b() {
5244         do_htlc_claim_previous_remote_commitment_only(true, false);
5245         do_htlc_claim_previous_remote_commitment_only(false, false);
5246         do_htlc_claim_previous_remote_commitment_only(true, true);
5247         do_htlc_claim_previous_remote_commitment_only(false, true);
5248 }
5249
5250 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>)
5251         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5252                                 F2: FnMut(),
5253 {
5254         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);
5255 }
5256
5257 // test_case
5258 // 0: node1 fails backward
5259 // 1: final node fails backward
5260 // 2: payment completed but the user rejects the payment
5261 // 3: final node fails backward (but tamper onion payloads from node0)
5262 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5263 // 200: trigger error in the final node and tamper returning fail_htlc
5264 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>)
5265         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5266                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5267                                 F3: FnMut(),
5268 {
5269
5270         // reset block height
5271         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5272         for ix in 0..nodes.len() {
5273                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5274         }
5275
5276         macro_rules! expect_event {
5277                 ($node: expr, $event_type: path) => {{
5278                         let events = $node.node.get_and_clear_pending_events();
5279                         assert_eq!(events.len(), 1);
5280                         match events[0] {
5281                                 $event_type { .. } => {},
5282                                 _ => panic!("Unexpected event"),
5283                         }
5284                 }}
5285         }
5286
5287         macro_rules! expect_htlc_forward {
5288                 ($node: expr) => {{
5289                         expect_event!($node, Event::PendingHTLCsForwardable);
5290                         $node.node.process_pending_htlc_forwards();
5291                 }}
5292         }
5293
5294         // 0 ~~> 2 send payment
5295         nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5296         check_added_monitors!(nodes[0], 1);
5297         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5298         // temper update_add (0 => 1)
5299         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5300         if test_case == 0 || test_case == 3 || test_case == 100 {
5301                 callback_msg(&mut update_add_0);
5302                 callback_node();
5303         }
5304         // 0 => 1 update_add & CS
5305         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5306         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5307
5308         let update_1_0 = match test_case {
5309                 0|100 => { // intermediate node failure; fail backward to 0
5310                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5311                         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));
5312                         update_1_0
5313                 },
5314                 1|2|3|200 => { // final node failure; forwarding to 2
5315                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5316                         // forwarding on 1
5317                         if test_case != 200 {
5318                                 callback_node();
5319                         }
5320                         expect_htlc_forward!(&nodes[1]);
5321
5322                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5323                         check_added_monitors!(&nodes[1], 1);
5324                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5325                         // tamper update_add (1 => 2)
5326                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5327                         if test_case != 3 && test_case != 200 {
5328                                 callback_msg(&mut update_add_1);
5329                         }
5330
5331                         // 1 => 2
5332                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5333                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5334
5335                         if test_case == 2 || test_case == 200 {
5336                                 expect_htlc_forward!(&nodes[2]);
5337                                 expect_event!(&nodes[2], Event::PaymentReceived);
5338                                 callback_node();
5339                                 expect_pending_htlcs_forwardable!(nodes[2]);
5340                         }
5341
5342                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5343                         if test_case == 2 || test_case == 200 {
5344                                 check_added_monitors!(&nodes[2], 1);
5345                         }
5346                         assert!(update_2_1.update_fail_htlcs.len() == 1);
5347
5348                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5349                         if test_case == 200 {
5350                                 callback_fail(&mut fail_msg);
5351                         }
5352
5353                         // 2 => 1
5354                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5355                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5356
5357                         // backward fail on 1
5358                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5359                         assert!(update_1_0.update_fail_htlcs.len() == 1);
5360                         update_1_0
5361                 },
5362                 _ => unreachable!(),
5363         };
5364
5365         // 1 => 0 commitment_signed_dance
5366         if update_1_0.update_fail_htlcs.len() > 0 {
5367                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5368                 if test_case == 100 {
5369                         callback_fail(&mut fail_msg);
5370                 }
5371                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5372         } else {
5373                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5374         };
5375
5376         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5377
5378         let events = nodes[0].node.get_and_clear_pending_events();
5379         assert_eq!(events.len(), 1);
5380         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
5381                 assert_eq!(*rejected_by_dest, !expected_retryable);
5382                 assert_eq!(*error_code, expected_error_code);
5383         } else {
5384                 panic!("Uexpected event");
5385         }
5386
5387         let events = nodes[0].node.get_and_clear_pending_msg_events();
5388         if expected_channel_update.is_some() {
5389                 assert_eq!(events.len(), 1);
5390                 match events[0] {
5391                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5392                                 match update {
5393                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5394                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5395                                                         panic!("channel_update not found!");
5396                                                 }
5397                                         },
5398                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5399                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5400                                                         assert!(*short_channel_id == *expected_short_channel_id);
5401                                                         assert!(*is_permanent == *expected_is_permanent);
5402                                                 } else {
5403                                                         panic!("Unexpected message event");
5404                                                 }
5405                                         },
5406                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5407                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5408                                                         assert!(*node_id == *expected_node_id);
5409                                                         assert!(*is_permanent == *expected_is_permanent);
5410                                                 } else {
5411                                                         panic!("Unexpected message event");
5412                                                 }
5413                                         },
5414                                 }
5415                         },
5416                         _ => panic!("Unexpected message event"),
5417                 }
5418         } else {
5419                 assert_eq!(events.len(), 0);
5420         }
5421 }
5422
5423 impl msgs::ChannelUpdate {
5424         fn dummy() -> msgs::ChannelUpdate {
5425                 use secp256k1::ffi::Signature as FFISignature;
5426                 use secp256k1::Signature;
5427                 msgs::ChannelUpdate {
5428                         signature: Signature::from(FFISignature::new()),
5429                         contents: msgs::UnsignedChannelUpdate {
5430                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5431                                 short_channel_id: 0,
5432                                 timestamp: 0,
5433                                 flags: 0,
5434                                 cltv_expiry_delta: 0,
5435                                 htlc_minimum_msat: 0,
5436                                 fee_base_msat: 0,
5437                                 fee_proportional_millionths: 0,
5438                                 excess_data: vec![],
5439                         }
5440                 }
5441         }
5442 }
5443
5444 struct BogusOnionHopData {
5445         data: Vec<u8>
5446 }
5447 impl BogusOnionHopData {
5448         fn new(orig: msgs::OnionHopData) -> Self {
5449                 Self { data: orig.encode() }
5450         }
5451 }
5452 impl Writeable for BogusOnionHopData {
5453         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5454                 writer.write_all(&self.data[..])
5455         }
5456 }
5457
5458 #[test]
5459 fn test_onion_failure() {
5460         use ln::msgs::ChannelUpdate;
5461         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5462         use secp256k1;
5463
5464         const BADONION: u16 = 0x8000;
5465         const PERM: u16 = 0x4000;
5466         const NODE: u16 = 0x2000;
5467         const UPDATE: u16 = 0x1000;
5468
5469         let chanmon_cfgs = create_chanmon_cfgs(3);
5470         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5471         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5472         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5473         for node in nodes.iter() {
5474                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5475         }
5476         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()), create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported())];
5477         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5478         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5479         // positve case
5480         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5481
5482         // intermediate node failure
5483         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5484                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5485                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5486                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5487                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5488                 let mut new_payloads = Vec::new();
5489                 for payload in onion_payloads.drain(..) {
5490                         new_payloads.push(BogusOnionHopData::new(payload));
5491                 }
5492                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5493                 // describing a length-1 TLV payload, which is obviously bogus.
5494                 new_payloads[0].data[0] = 1;
5495                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5496         }, ||{}, 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
5497
5498         // final node failure
5499         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5500                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5501                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5502                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5503                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5504                 let mut new_payloads = Vec::new();
5505                 for payload in onion_payloads.drain(..) {
5506                         new_payloads.push(BogusOnionHopData::new(payload));
5507                 }
5508                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5509                 // length-1 TLV payload, which is obviously bogus.
5510                 new_payloads[1].data[0] = 1;
5511                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5512         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5513
5514         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5515         // receiving simulated fail messages
5516         // intermediate node failure
5517         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5518                 // trigger error
5519                 msg.amount_msat -= 1;
5520         }, |msg| {
5521                 // and tamper returning error message
5522                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5523                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5524                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5525         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
5526
5527         // final node failure
5528         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5529                 // and tamper returning error message
5530                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5531                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5532                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5533         }, ||{
5534                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5535         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
5536
5537         // intermediate node failure
5538         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5539                 msg.amount_msat -= 1;
5540         }, |msg| {
5541                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5542                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5543                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5544         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5545
5546         // final node failure
5547         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5548                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5549                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5550                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5551         }, ||{
5552                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5553         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5554
5555         // intermediate node failure
5556         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5557                 msg.amount_msat -= 1;
5558         }, |msg| {
5559                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5560                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5561                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5562         }, ||{
5563                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5564         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5565
5566         // final node failure
5567         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5568                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5569                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5570                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5571         }, ||{
5572                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5573         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5574
5575         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5576                 Some(BADONION|PERM|4), None);
5577
5578         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5579                 Some(BADONION|PERM|5), None);
5580
5581         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5582                 Some(BADONION|PERM|6), None);
5583
5584         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5585                 msg.amount_msat -= 1;
5586         }, |msg| {
5587                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5588                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5589                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5590         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5591
5592         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5593                 msg.amount_msat -= 1;
5594         }, |msg| {
5595                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5596                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5597                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5598                 // short_channel_id from the processing node
5599         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5600
5601         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5602                 msg.amount_msat -= 1;
5603         }, |msg| {
5604                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5605                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5606                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5607                 // short_channel_id from the processing node
5608         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5609
5610         let mut bogus_route = route.clone();
5611         bogus_route.paths[0][1].short_channel_id -= 1;
5612         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5613           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
5614
5615         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5616         let mut bogus_route = route.clone();
5617         let route_len = bogus_route.paths[0].len();
5618         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
5619         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5620
5621         //TODO: with new config API, we will be able to generate both valid and
5622         //invalid channel_update cases.
5623         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5624                 msg.amount_msat -= 1;
5625         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5626
5627         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5628                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5629                 msg.cltv_expiry -= 1;
5630         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5631
5632         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5633                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5634                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5635
5636                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5637         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5638
5639         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5640                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5641         }, false, Some(PERM|15), None);
5642
5643         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5644                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5645                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5646
5647                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5648         }, || {}, true, Some(17), None);
5649
5650         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5651                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5652                         for f in pending_forwards.iter_mut() {
5653                                 match f {
5654                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5655                                                 forward_info.outgoing_cltv_value += 1,
5656                                         _ => {},
5657                                 }
5658                         }
5659                 }
5660         }, true, Some(18), None);
5661
5662         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5663                 // violate amt_to_forward > msg.amount_msat
5664                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5665                         for f in pending_forwards.iter_mut() {
5666                                 match f {
5667                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5668                                                 forward_info.amt_to_forward -= 1,
5669                                         _ => {},
5670                                 }
5671                         }
5672                 }
5673         }, true, Some(19), None);
5674
5675         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5676                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5677                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5678                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5679         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5680         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5681
5682         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5683                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5684                 let mut route = route.clone();
5685                 let height = 1;
5686                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
5687                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5688                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
5689                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5690                 msg.cltv_expiry = htlc_cltv;
5691                 msg.onion_routing_packet = onion_packet;
5692         }, ||{}, true, Some(21), None);
5693 }
5694
5695 #[test]
5696 #[should_panic]
5697 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5698         let chanmon_cfgs = create_chanmon_cfgs(2);
5699         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5700         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5701         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5702         //Force duplicate channel ids
5703         for node in nodes.iter() {
5704                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5705         }
5706
5707         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5708         let channel_value_satoshis=10000;
5709         let push_msat=10001;
5710         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5711         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5712         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5713
5714         //Create a second channel with a channel_id collision
5715         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5716 }
5717
5718 #[test]
5719 fn bolt2_open_channel_sending_node_checks_part2() {
5720         let chanmon_cfgs = create_chanmon_cfgs(2);
5721         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5722         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5723         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5724
5725         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5726         let channel_value_satoshis=2^24;
5727         let push_msat=10001;
5728         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5729
5730         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5731         let channel_value_satoshis=10000;
5732         // Test when push_msat is equal to 1000 * funding_satoshis.
5733         let push_msat=1000*channel_value_satoshis+1;
5734         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5735
5736         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5737         let channel_value_satoshis=10000;
5738         let push_msat=10001;
5739         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
5740         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5741         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5742
5743         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5744         // 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
5745         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5746
5747         // 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.
5748         assert!(BREAKDOWN_TIMEOUT>0);
5749         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5750
5751         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5752         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5753         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5754
5755         // 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.
5756         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5757         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5758         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5759         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5760         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5761 }
5762
5763 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5764 // 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.
5765 //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.
5766
5767 #[test]
5768 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5769         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5770         let chanmon_cfgs = create_chanmon_cfgs(2);
5771         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5772         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5773         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5774         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5775         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5776         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5777
5778         route.paths[0][0].fee_msat = 100;
5779
5780         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5781                 assert_eq!(err, "Cannot send less than their minimum HTLC value"));
5782         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5783         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5784 }
5785
5786 #[test]
5787 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
5788         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5789         let chanmon_cfgs = create_chanmon_cfgs(2);
5790         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5791         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5792         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5793         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5794         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5795         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5796
5797         route.paths[0][0].fee_msat = 0;
5798
5799         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5800                 assert_eq!(err, "Cannot send 0-msat HTLC"));
5801         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5802         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
5803 }
5804
5805 #[test]
5806 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
5807         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5808         let chanmon_cfgs = create_chanmon_cfgs(2);
5809         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5810         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5811         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5812         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5813         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5814         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5815
5816         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5817         check_added_monitors!(nodes[0], 1);
5818         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5819         updates.update_add_htlcs[0].amount_msat = 0;
5820
5821         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5822         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
5823         check_closed_broadcast!(nodes[1], true).unwrap();
5824         check_added_monitors!(nodes[1], 1);
5825 }
5826
5827 #[test]
5828 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5829         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5830         //It is enforced when constructing a route.
5831         let chanmon_cfgs = create_chanmon_cfgs(2);
5832         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5833         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5834         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5835         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5836         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5837         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5838
5839         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { err },
5840                 assert_eq!(err, "Channel CLTV overflowed?!"));
5841 }
5842
5843 #[test]
5844 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5845         //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.
5846         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5847         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5848         let chanmon_cfgs = create_chanmon_cfgs(2);
5849         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5850         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5851         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5852         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5853         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5854
5855         for i in 0..max_accepted_htlcs {
5856                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5857                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5858                 let payment_event = {
5859                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5860                         check_added_monitors!(nodes[0], 1);
5861
5862                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5863                         assert_eq!(events.len(), 1);
5864                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5865                                 assert_eq!(htlcs[0].htlc_id, i);
5866                         } else {
5867                                 assert!(false);
5868                         }
5869                         SendEvent::from_event(events.remove(0))
5870                 };
5871                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5872                 check_added_monitors!(nodes[1], 0);
5873                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5874
5875                 expect_pending_htlcs_forwardable!(nodes[1]);
5876                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5877         }
5878         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5879         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5880         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5881                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
5882
5883         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5884         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5885 }
5886
5887 #[test]
5888 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5889         //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.
5890         let chanmon_cfgs = create_chanmon_cfgs(2);
5891         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5892         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5893         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5894         let channel_value = 100000;
5895         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5896         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5897
5898         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5899
5900         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5901         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5902         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5903                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
5904
5905         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5906         nodes[0].logger.assert_log("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);
5907
5908         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5909 }
5910
5911 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5912 #[test]
5913 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5914         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5915         let chanmon_cfgs = create_chanmon_cfgs(2);
5916         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5917         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5918         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5919         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5920         let htlc_minimum_msat: u64;
5921         {
5922                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5923                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5924                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5925         }
5926         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5927         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5928         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5929         check_added_monitors!(nodes[0], 1);
5930         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5931         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5932         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5933         assert!(nodes[1].node.list_channels().is_empty());
5934         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5935         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5936         check_added_monitors!(nodes[1], 1);
5937 }
5938
5939 #[test]
5940 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5941         //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
5942         let chanmon_cfgs = create_chanmon_cfgs(2);
5943         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5944         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5945         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5946         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5947
5948         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5949
5950         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5951         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5952         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5953         check_added_monitors!(nodes[0], 1);
5954         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5955
5956         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5957         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5958
5959         assert!(nodes[1].node.list_channels().is_empty());
5960         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5961         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5962         check_added_monitors!(nodes[1], 1);
5963 }
5964
5965 #[test]
5966 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5967         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5968         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5969         let chanmon_cfgs = create_chanmon_cfgs(2);
5970         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5971         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5972         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5973         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5974         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5975         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5976
5977         let session_priv = SecretKey::from_slice(&{
5978                 let mut session_key = [0; 32];
5979                 let mut rng = thread_rng();
5980                 rng.fill_bytes(&mut session_key);
5981                 session_key
5982         }).expect("RNG is bad!");
5983
5984         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5985         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
5986         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
5987         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5988
5989         let mut msg = msgs::UpdateAddHTLC {
5990                 channel_id: chan.2,
5991                 htlc_id: 0,
5992                 amount_msat: 1000,
5993                 payment_hash: our_payment_hash,
5994                 cltv_expiry: htlc_cltv,
5995                 onion_routing_packet: onion_packet.clone(),
5996         };
5997
5998         for i in 0..super::channel::OUR_MAX_HTLCS {
5999                 msg.htlc_id = i as u64;
6000                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6001         }
6002         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
6003         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
6004
6005         assert!(nodes[1].node.list_channels().is_empty());
6006         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6007         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
6008         check_added_monitors!(nodes[1], 1);
6009 }
6010
6011 #[test]
6012 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
6013         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
6014         let chanmon_cfgs = create_chanmon_cfgs(2);
6015         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6016         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6017         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6018         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6019         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6020         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6021         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6022         check_added_monitors!(nodes[0], 1);
6023         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6024         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
6025         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6026
6027         assert!(nodes[1].node.list_channels().is_empty());
6028         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6029         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
6030         check_added_monitors!(nodes[1], 1);
6031 }
6032
6033 #[test]
6034 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6035         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6036         let chanmon_cfgs = create_chanmon_cfgs(2);
6037         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6038         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6039         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6040         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
6041         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
6042         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6043         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6044         check_added_monitors!(nodes[0], 1);
6045         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6046         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6047         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6048
6049         assert!(nodes[1].node.list_channels().is_empty());
6050         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6051         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6052         check_added_monitors!(nodes[1], 1);
6053 }
6054
6055 #[test]
6056 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6057         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6058         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6059         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6060         let chanmon_cfgs = create_chanmon_cfgs(2);
6061         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6062         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6063         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6064         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6065         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6066         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6067         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6068         check_added_monitors!(nodes[0], 1);
6069         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6070         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6071
6072         //Disconnect and Reconnect
6073         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6074         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6075         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6076         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6077         assert_eq!(reestablish_1.len(), 1);
6078         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6079         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6080         assert_eq!(reestablish_2.len(), 1);
6081         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6082         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6083         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6084         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6085
6086         //Resend HTLC
6087         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6088         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6089         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6090         check_added_monitors!(nodes[1], 1);
6091         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6092
6093         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6094
6095         assert!(nodes[1].node.list_channels().is_empty());
6096         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6097         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
6098         check_added_monitors!(nodes[1], 1);
6099 }
6100
6101 #[test]
6102 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6103         //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.
6104
6105         let chanmon_cfgs = create_chanmon_cfgs(2);
6106         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6107         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6108         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6109         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6110
6111         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6112         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6113         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6114         check_added_monitors!(nodes[0], 1);
6115         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6116         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6117
6118         let update_msg = msgs::UpdateFulfillHTLC{
6119                 channel_id: chan.2,
6120                 htlc_id: 0,
6121                 payment_preimage: our_payment_preimage,
6122         };
6123
6124         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6125
6126         assert!(nodes[0].node.list_channels().is_empty());
6127         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6128         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6129         check_added_monitors!(nodes[0], 1);
6130 }
6131
6132 #[test]
6133 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6134         //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.
6135
6136         let chanmon_cfgs = create_chanmon_cfgs(2);
6137         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6138         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6139         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6140         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6141
6142         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6143         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6144         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6145         check_added_monitors!(nodes[0], 1);
6146         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6147         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6148
6149         let update_msg = msgs::UpdateFailHTLC{
6150                 channel_id: chan.2,
6151                 htlc_id: 0,
6152                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6153         };
6154
6155         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6156
6157         assert!(nodes[0].node.list_channels().is_empty());
6158         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6159         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6160         check_added_monitors!(nodes[0], 1);
6161 }
6162
6163 #[test]
6164 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6165         //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.
6166
6167         let chanmon_cfgs = create_chanmon_cfgs(2);
6168         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6169         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6170         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6171         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6172
6173         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6174         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6175         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6176         check_added_monitors!(nodes[0], 1);
6177         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6178         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6179
6180         let update_msg = msgs::UpdateFailMalformedHTLC{
6181                 channel_id: chan.2,
6182                 htlc_id: 0,
6183                 sha256_of_onion: [1; 32],
6184                 failure_code: 0x8000,
6185         };
6186
6187         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6188
6189         assert!(nodes[0].node.list_channels().is_empty());
6190         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6191         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6192         check_added_monitors!(nodes[0], 1);
6193 }
6194
6195 #[test]
6196 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6197         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6198
6199         let chanmon_cfgs = create_chanmon_cfgs(2);
6200         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6201         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6202         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6203         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6204
6205         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6206
6207         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6208         check_added_monitors!(nodes[1], 1);
6209
6210         let events = nodes[1].node.get_and_clear_pending_msg_events();
6211         assert_eq!(events.len(), 1);
6212         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6213                 match events[0] {
6214                         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, .. } } => {
6215                                 assert!(update_add_htlcs.is_empty());
6216                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6217                                 assert!(update_fail_htlcs.is_empty());
6218                                 assert!(update_fail_malformed_htlcs.is_empty());
6219                                 assert!(update_fee.is_none());
6220                                 update_fulfill_htlcs[0].clone()
6221                         },
6222                         _ => panic!("Unexpected event"),
6223                 }
6224         };
6225
6226         update_fulfill_msg.htlc_id = 1;
6227
6228         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6229
6230         assert!(nodes[0].node.list_channels().is_empty());
6231         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6232         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6233         check_added_monitors!(nodes[0], 1);
6234 }
6235
6236 #[test]
6237 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6238         //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.
6239
6240         let chanmon_cfgs = create_chanmon_cfgs(2);
6241         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6242         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6243         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6244         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6245
6246         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6247
6248         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6249         check_added_monitors!(nodes[1], 1);
6250
6251         let events = nodes[1].node.get_and_clear_pending_msg_events();
6252         assert_eq!(events.len(), 1);
6253         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6254                 match events[0] {
6255                         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, .. } } => {
6256                                 assert!(update_add_htlcs.is_empty());
6257                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6258                                 assert!(update_fail_htlcs.is_empty());
6259                                 assert!(update_fail_malformed_htlcs.is_empty());
6260                                 assert!(update_fee.is_none());
6261                                 update_fulfill_htlcs[0].clone()
6262                         },
6263                         _ => panic!("Unexpected event"),
6264                 }
6265         };
6266
6267         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6268
6269         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6270
6271         assert!(nodes[0].node.list_channels().is_empty());
6272         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6273         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
6274         check_added_monitors!(nodes[0], 1);
6275 }
6276
6277 #[test]
6278 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6279         //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.
6280
6281         let chanmon_cfgs = create_chanmon_cfgs(2);
6282         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6283         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6284         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6285         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6286         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6287         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6288         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6289         check_added_monitors!(nodes[0], 1);
6290
6291         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6292         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6293
6294         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6295         check_added_monitors!(nodes[1], 0);
6296         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6297
6298         let events = nodes[1].node.get_and_clear_pending_msg_events();
6299
6300         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6301                 match events[0] {
6302                         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, .. } } => {
6303                                 assert!(update_add_htlcs.is_empty());
6304                                 assert!(update_fulfill_htlcs.is_empty());
6305                                 assert!(update_fail_htlcs.is_empty());
6306                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6307                                 assert!(update_fee.is_none());
6308                                 update_fail_malformed_htlcs[0].clone()
6309                         },
6310                         _ => panic!("Unexpected event"),
6311                 }
6312         };
6313         update_msg.failure_code &= !0x8000;
6314         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6315
6316         assert!(nodes[0].node.list_channels().is_empty());
6317         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6318         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6319         check_added_monitors!(nodes[0], 1);
6320 }
6321
6322 #[test]
6323 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6324         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6325         //    * 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.
6326
6327         let chanmon_cfgs = create_chanmon_cfgs(3);
6328         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6329         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6330         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6331         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6332         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6333
6334         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
6335         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6336
6337         //First hop
6338         let mut payment_event = {
6339                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6340                 check_added_monitors!(nodes[0], 1);
6341                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6342                 assert_eq!(events.len(), 1);
6343                 SendEvent::from_event(events.remove(0))
6344         };
6345         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6346         check_added_monitors!(nodes[1], 0);
6347         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6348         expect_pending_htlcs_forwardable!(nodes[1]);
6349         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6350         assert_eq!(events_2.len(), 1);
6351         check_added_monitors!(nodes[1], 1);
6352         payment_event = SendEvent::from_event(events_2.remove(0));
6353         assert_eq!(payment_event.msgs.len(), 1);
6354
6355         //Second Hop
6356         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6357         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6358         check_added_monitors!(nodes[2], 0);
6359         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6360
6361         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6362         assert_eq!(events_3.len(), 1);
6363         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6364                 match events_3[0] {
6365                         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 } } => {
6366                                 assert!(update_add_htlcs.is_empty());
6367                                 assert!(update_fulfill_htlcs.is_empty());
6368                                 assert!(update_fail_htlcs.is_empty());
6369                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6370                                 assert!(update_fee.is_none());
6371                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6372                         },
6373                         _ => panic!("Unexpected event"),
6374                 }
6375         };
6376
6377         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6378
6379         check_added_monitors!(nodes[1], 0);
6380         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6381         expect_pending_htlcs_forwardable!(nodes[1]);
6382         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6383         assert_eq!(events_4.len(), 1);
6384
6385         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6386         match events_4[0] {
6387                 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, .. } } => {
6388                         assert!(update_add_htlcs.is_empty());
6389                         assert!(update_fulfill_htlcs.is_empty());
6390                         assert_eq!(update_fail_htlcs.len(), 1);
6391                         assert!(update_fail_malformed_htlcs.is_empty());
6392                         assert!(update_fee.is_none());
6393                 },
6394                 _ => panic!("Unexpected event"),
6395         };
6396
6397         check_added_monitors!(nodes[1], 1);
6398 }
6399
6400 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6401         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6402         // 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
6403         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6404
6405         let chanmon_cfgs = create_chanmon_cfgs(2);
6406         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6407         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6408         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6409         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6410
6411         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6412
6413         // We route 2 dust-HTLCs between A and B
6414         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6415         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6416         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6417
6418         // Cache one local commitment tx as previous
6419         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6420
6421         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6422         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
6423         check_added_monitors!(nodes[1], 0);
6424         expect_pending_htlcs_forwardable!(nodes[1]);
6425         check_added_monitors!(nodes[1], 1);
6426
6427         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6428         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6429         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6430         check_added_monitors!(nodes[0], 1);
6431
6432         // Cache one local commitment tx as lastest
6433         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6434
6435         let events = nodes[0].node.get_and_clear_pending_msg_events();
6436         match events[0] {
6437                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6438                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6439                 },
6440                 _ => panic!("Unexpected event"),
6441         }
6442         match events[1] {
6443                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6444                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6445                 },
6446                 _ => panic!("Unexpected event"),
6447         }
6448
6449         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6450         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6451         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6452
6453         if announce_latest {
6454                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6455         } else {
6456                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6457         }
6458
6459         check_closed_broadcast!(nodes[0], false);
6460         check_added_monitors!(nodes[0], 1);
6461
6462         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6463         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
6464         let events = nodes[0].node.get_and_clear_pending_events();
6465         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6466         assert_eq!(events.len(), 2);
6467         let mut first_failed = false;
6468         for event in events {
6469                 match event {
6470                         Event::PaymentFailed { payment_hash, .. } => {
6471                                 if payment_hash == payment_hash_1 {
6472                                         assert!(!first_failed);
6473                                         first_failed = true;
6474                                 } else {
6475                                         assert_eq!(payment_hash, payment_hash_2);
6476                                 }
6477                         }
6478                         _ => panic!("Unexpected event"),
6479                 }
6480         }
6481 }
6482
6483 #[test]
6484 fn test_failure_delay_dust_htlc_local_commitment() {
6485         do_test_failure_delay_dust_htlc_local_commitment(true);
6486         do_test_failure_delay_dust_htlc_local_commitment(false);
6487 }
6488
6489 #[test]
6490 fn test_no_failure_dust_htlc_local_commitment() {
6491         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6492         // prone to error, we test here that a dummy transaction don't fail them.
6493
6494         let chanmon_cfgs = create_chanmon_cfgs(2);
6495         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6496         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6497         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6498         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6499
6500         // Rebalance a bit
6501         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6502
6503         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6504         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6505
6506         // We route 2 dust-HTLCs between A and B
6507         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6508         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6509
6510         // Build a dummy invalid transaction trying to spend a commitment tx
6511         let input = TxIn {
6512                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6513                 script_sig: Script::new(),
6514                 sequence: 0,
6515                 witness: Vec::new(),
6516         };
6517
6518         let outp = TxOut {
6519                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6520                 value: 10000,
6521         };
6522
6523         let dummy_tx = Transaction {
6524                 version: 2,
6525                 lock_time: 0,
6526                 input: vec![input],
6527                 output: vec![outp]
6528         };
6529
6530         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6531         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6532         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6533         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6534         // We broadcast a few more block to check everything is all right
6535         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
6536         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6537         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6538
6539         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6540         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6541 }
6542
6543 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6544         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6545         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6546         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6547         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6548         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6549         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6550
6551         let chanmon_cfgs = create_chanmon_cfgs(3);
6552         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6553         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6554         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6555         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6556
6557         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6558
6559         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6560         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6561
6562         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6563         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
6564
6565         // We revoked bs_commitment_tx
6566         if revoked {
6567                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6568                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6569         }
6570
6571         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6572         let mut timeout_tx = Vec::new();
6573         if local {
6574                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6575                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6576                 check_closed_broadcast!(nodes[0], false);
6577                 check_added_monitors!(nodes[0], 1);
6578                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6579                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6580                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6581                 let events = nodes[0].node.get_and_clear_pending_events();
6582                 assert_eq!(events.len(), 1);
6583                 match events[0] {
6584                         Event::PaymentFailed { payment_hash, .. } => {
6585                                 assert_eq!(payment_hash, dust_hash);
6586                         },
6587                         _ => panic!("Unexpected event"),
6588                 }
6589                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6590                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6591                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6592                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6593                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6594                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6595                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6596                 let events = nodes[0].node.get_and_clear_pending_events();
6597                 assert_eq!(events.len(), 1);
6598                 match events[0] {
6599                         Event::PaymentFailed { payment_hash, .. } => {
6600                                 assert_eq!(payment_hash, non_dust_hash);
6601                         },
6602                         _ => panic!("Unexpected event"),
6603                 }
6604         } else {
6605                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6606                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6607                 check_closed_broadcast!(nodes[0], false);
6608                 check_added_monitors!(nodes[0], 1);
6609                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6610                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6611                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6612                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6613                 if !revoked {
6614                         let events = nodes[0].node.get_and_clear_pending_events();
6615                         assert_eq!(events.len(), 1);
6616                         match events[0] {
6617                                 Event::PaymentFailed { payment_hash, .. } => {
6618                                         assert_eq!(payment_hash, dust_hash);
6619                                 },
6620                                 _ => panic!("Unexpected event"),
6621                         }
6622                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6623                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6624                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6625                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6626                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6627                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6628                         let events = nodes[0].node.get_and_clear_pending_events();
6629                         assert_eq!(events.len(), 1);
6630                         match events[0] {
6631                                 Event::PaymentFailed { payment_hash, .. } => {
6632                                         assert_eq!(payment_hash, non_dust_hash);
6633                                 },
6634                                 _ => panic!("Unexpected event"),
6635                         }
6636                 } else {
6637                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6638                         // commitment tx
6639                         let events = nodes[0].node.get_and_clear_pending_events();
6640                         assert_eq!(events.len(), 2);
6641                         let first;
6642                         match events[0] {
6643                                 Event::PaymentFailed { payment_hash, .. } => {
6644                                         if payment_hash == dust_hash { first = true; }
6645                                         else { first = false; }
6646                                 },
6647                                 _ => panic!("Unexpected event"),
6648                         }
6649                         match events[1] {
6650                                 Event::PaymentFailed { payment_hash, .. } => {
6651                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6652                                         else { assert_eq!(payment_hash, dust_hash); }
6653                                 },
6654                                 _ => panic!("Unexpected event"),
6655                         }
6656                 }
6657         }
6658 }
6659
6660 #[test]
6661 fn test_sweep_outbound_htlc_failure_update() {
6662         do_test_sweep_outbound_htlc_failure_update(false, true);
6663         do_test_sweep_outbound_htlc_failure_update(false, false);
6664         do_test_sweep_outbound_htlc_failure_update(true, false);
6665 }
6666
6667 #[test]
6668 fn test_upfront_shutdown_script() {
6669         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6670         // enforce it at shutdown message
6671
6672         let mut config = UserConfig::default();
6673         config.channel_options.announced_channel = true;
6674         config.peer_channel_config_limits.force_announced_channel_preference = false;
6675         config.channel_options.commit_upfront_shutdown_pubkey = false;
6676         let user_cfgs = [None, Some(config), None];
6677         let chanmon_cfgs = create_chanmon_cfgs(3);
6678         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6679         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6680         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6681
6682         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6683         let flags = InitFeatures::supported();
6684         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6685         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6686         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6687         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6688         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6689         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6690         assert_eq!(check_closed_broadcast!(nodes[2], true).unwrap().data, "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6691         check_added_monitors!(nodes[2], 1);
6692
6693         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6694         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6695         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6696         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6697         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6698         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6699         let events = nodes[2].node.get_and_clear_pending_msg_events();
6700         assert_eq!(events.len(), 1);
6701         match events[0] {
6702                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6703                 _ => panic!("Unexpected event"),
6704         }
6705
6706         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6707         let mut flags_no = InitFeatures::supported();
6708         flags_no.unset_upfront_shutdown_script();
6709         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6710         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6711         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6712         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6713         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6714         let events = nodes[1].node.get_and_clear_pending_msg_events();
6715         assert_eq!(events.len(), 1);
6716         match events[0] {
6717                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6718                 _ => panic!("Unexpected event"),
6719         }
6720
6721         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6722         // channel smoothly, opt-out is from channel initiator here
6723         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6724         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6725         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6726         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6727         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6728         let events = nodes[0].node.get_and_clear_pending_msg_events();
6729         assert_eq!(events.len(), 1);
6730         match events[0] {
6731                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6732                 _ => panic!("Unexpected event"),
6733         }
6734
6735         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6736         //// channel smoothly
6737         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6738         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6739         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6740         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6741         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6742         let events = nodes[0].node.get_and_clear_pending_msg_events();
6743         assert_eq!(events.len(), 2);
6744         match events[0] {
6745                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6746                 _ => panic!("Unexpected event"),
6747         }
6748         match events[1] {
6749                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6750                 _ => panic!("Unexpected event"),
6751         }
6752 }
6753
6754 #[test]
6755 fn test_user_configurable_csv_delay() {
6756         // We test our channel constructors yield errors when we pass them absurd csv delay
6757
6758         let mut low_our_to_self_config = UserConfig::default();
6759         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6760         let mut high_their_to_self_config = UserConfig::default();
6761         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6762         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
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, &user_cfgs);
6766         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6767
6768         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6769         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
6770         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, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6771                 match error {
6772                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6773                         _ => panic!("Unexpected event"),
6774                 }
6775         } else { assert!(false) }
6776
6777         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6778         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6779         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6780         open_channel.to_self_delay = 200;
6781         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::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6782                 match error {
6783                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6784                         _ => panic!("Unexpected event"),
6785                 }
6786         } else { assert!(false); }
6787
6788         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6789         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6790         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
6791         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6792         accept_channel.to_self_delay = 200;
6793         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6794         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6795                 match action {
6796                         &ErrorAction::SendErrorMessage { ref msg } => {
6797                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6798                         },
6799                         _ => { assert!(false); }
6800                 }
6801         } else { assert!(false); }
6802
6803         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6804         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6805         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6806         open_channel.to_self_delay = 200;
6807         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::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &high_their_to_self_config) {
6808                 match error {
6809                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6810                         _ => panic!("Unexpected event"),
6811                 }
6812         } else { assert!(false); }
6813 }
6814
6815 #[test]
6816 fn test_data_loss_protect() {
6817         // We want to be sure that :
6818         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6819         // * we close channel in case of detecting other being fallen behind
6820         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6821         let keys_manager;
6822         let fee_estimator;
6823         let tx_broadcaster;
6824         let monitor;
6825         let node_state_0;
6826         let chanmon_cfgs = create_chanmon_cfgs(2);
6827         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6828         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6829         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6830
6831         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6832
6833         // Cache node A state before any channel update
6834         let previous_node_state = nodes[0].node.encode();
6835         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6836         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6837
6838         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6839         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6840
6841         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6842         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6843
6844         // Restore node A from previous state
6845         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6846         let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6847         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6848         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
6849         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
6850         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger));
6851         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &tx_broadcaster, logger.clone(), &fee_estimator);
6852         node_state_0 = {
6853                 let mut channel_monitors = HashMap::new();
6854                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6855                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6856                         keys_manager: &keys_manager,
6857                         fee_estimator: &fee_estimator,
6858                         monitor: &monitor,
6859                         logger: Arc::clone(&logger),
6860                         tx_broadcaster: &tx_broadcaster,
6861                         default_config: UserConfig::default(),
6862                         channel_monitors: &mut channel_monitors,
6863                 }).unwrap().1
6864         };
6865         nodes[0].node = &node_state_0;
6866         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
6867         nodes[0].chan_monitor = &monitor;
6868         nodes[0].chain_monitor = chain_monitor;
6869
6870         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6871         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6872         nodes[0].block_notifier.register_listener(nodes[0].node);
6873
6874         check_added_monitors!(nodes[0], 1);
6875
6876         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6877         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6878
6879         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6880
6881         // Check we update monitor following learning of per_commitment_point from B
6882         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6883         check_added_monitors!(nodes[0], 2);
6884
6885         {
6886                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6887                 assert_eq!(node_txn.len(), 0);
6888         }
6889
6890         let mut reestablish_1 = Vec::with_capacity(1);
6891         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6892                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6893                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6894                         reestablish_1.push(msg.clone());
6895                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6896                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6897                         match action {
6898                                 &ErrorAction::SendErrorMessage { ref msg } => {
6899                                         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");
6900                                 },
6901                                 _ => panic!("Unexpected event!"),
6902                         }
6903                 } else {
6904                         panic!("Unexpected event")
6905                 }
6906         }
6907
6908         // Check we close channel detecting A is fallen-behind
6909         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6910         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
6911         check_added_monitors!(nodes[1], 1);
6912
6913
6914         // Check A is able to claim to_remote output
6915         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6916         assert_eq!(node_txn.len(), 1);
6917         check_spends!(node_txn[0], chan.3);
6918         assert_eq!(node_txn[0].output.len(), 2);
6919         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6920         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
6921         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
6922         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6923         assert_eq!(spend_txn.len(), 1);
6924         check_spends!(spend_txn[0], node_txn[0]);
6925 }
6926
6927 #[test]
6928 fn test_check_htlc_underpaying() {
6929         // Send payment through A -> B but A is maliciously
6930         // sending a probe payment (i.e less than expected value0
6931         // to B, B should refuse payment.
6932
6933         let chanmon_cfgs = create_chanmon_cfgs(2);
6934         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6935         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6936         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6937
6938         // Create some initial channels
6939         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6940
6941         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6942
6943         // Node 3 is expecting payment of 100_000 but receive 10_000,
6944         // fail htlc like we didn't know the preimage.
6945         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
6946         nodes[1].node.process_pending_htlc_forwards();
6947
6948         let events = nodes[1].node.get_and_clear_pending_msg_events();
6949         assert_eq!(events.len(), 1);
6950         let (update_fail_htlc, commitment_signed) = match events[0] {
6951                 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 } } => {
6952                         assert!(update_add_htlcs.is_empty());
6953                         assert!(update_fulfill_htlcs.is_empty());
6954                         assert_eq!(update_fail_htlcs.len(), 1);
6955                         assert!(update_fail_malformed_htlcs.is_empty());
6956                         assert!(update_fee.is_none());
6957                         (update_fail_htlcs[0].clone(), commitment_signed)
6958                 },
6959                 _ => panic!("Unexpected event"),
6960         };
6961         check_added_monitors!(nodes[1], 1);
6962
6963         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6964         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6965
6966         let events = nodes[0].node.get_and_clear_pending_events();
6967         assert_eq!(events.len(), 1);
6968         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, ref error_data } = &events[0] {
6969                 assert_eq!(*rejected_by_dest, true);
6970                 assert_eq!(error_code.unwrap(), 0x4000|15);
6971                 // 10_000 msat as u64, followed by a height of 99 as u32
6972                 assert_eq!(&error_data.as_ref().unwrap()[..], &[
6973                         ((10_000u64 >> 7*8) & 0xff) as u8,
6974                         ((10_000u64 >> 6*8) & 0xff) as u8,
6975                         ((10_000u64 >> 5*8) & 0xff) as u8,
6976                         ((10_000u64 >> 4*8) & 0xff) as u8,
6977                         ((10_000u64 >> 3*8) & 0xff) as u8,
6978                         ((10_000u64 >> 2*8) & 0xff) as u8,
6979                         ((10_000u64 >> 1*8) & 0xff) as u8,
6980                         ((10_000u64 >> 0*8) & 0xff) as u8,
6981                         0, 0, 0, 99]);
6982         } else {
6983                 panic!("Unexpected event");
6984         }
6985         nodes[1].node.get_and_clear_pending_events();
6986 }
6987
6988 #[test]
6989 fn test_announce_disable_channels() {
6990         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6991         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
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 nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6997
6998         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6999         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7000         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7001
7002         // Disconnect peers
7003         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7004         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7005
7006         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
7007         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
7008         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
7009         assert_eq!(msg_events.len(), 3);
7010         for e in msg_events {
7011                 match e {
7012                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
7013                                 let short_id = msg.contents.short_channel_id;
7014                                 // Check generated channel_update match list in PendingChannelUpdate
7015                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
7016                                         panic!("Generated ChannelUpdate for wrong chan!");
7017                                 }
7018                         },
7019                         _ => panic!("Unexpected event"),
7020                 }
7021         }
7022         // Reconnect peers
7023         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7024         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7025         assert_eq!(reestablish_1.len(), 3);
7026         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
7027         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7028         assert_eq!(reestablish_2.len(), 3);
7029
7030         // Reestablish chan_1
7031         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
7032         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7033         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
7034         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7035         // Reestablish chan_2
7036         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7037         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7038         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7039         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7040         // Reestablish chan_3
7041         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7042         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7043         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7044         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7045
7046         nodes[0].node.timer_chan_freshness_every_min();
7047         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7048 }
7049
7050 #[test]
7051 fn test_bump_penalty_txn_on_revoked_commitment() {
7052         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7053         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7054
7055         let chanmon_cfgs = create_chanmon_cfgs(2);
7056         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7057         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7058         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7059
7060         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7061         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7062         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
7063         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7064
7065         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7066         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7067         assert_eq!(revoked_txn[0].output.len(), 4);
7068         assert_eq!(revoked_txn[0].input.len(), 1);
7069         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7070         let revoked_txid = revoked_txn[0].txid();
7071
7072         let mut penalty_sum = 0;
7073         for outp in revoked_txn[0].output.iter() {
7074                 if outp.script_pubkey.is_v0_p2wsh() {
7075                         penalty_sum += outp.value;
7076                 }
7077         }
7078
7079         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7080         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
7081
7082         // Actually revoke tx by claiming a HTLC
7083         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7084         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7085         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7086         check_added_monitors!(nodes[1], 1);
7087
7088         // One or more justice tx should have been broadcast, check it
7089         let penalty_1;
7090         let feerate_1;
7091         {
7092                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7093                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7094                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7095                 assert_eq!(node_txn[0].output.len(), 1);
7096                 check_spends!(node_txn[0], revoked_txn[0]);
7097                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7098                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7099                 penalty_1 = node_txn[0].txid();
7100                 node_txn.clear();
7101         };
7102
7103         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7104         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
7105         let mut penalty_2 = penalty_1;
7106         let mut feerate_2 = 0;
7107         {
7108                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7109                 assert_eq!(node_txn.len(), 1);
7110                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7111                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7112                         assert_eq!(node_txn[0].output.len(), 1);
7113                         check_spends!(node_txn[0], revoked_txn[0]);
7114                         penalty_2 = node_txn[0].txid();
7115                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7116                         assert_ne!(penalty_2, penalty_1);
7117                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7118                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7119                         // Verify 25% bump heuristic
7120                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7121                         node_txn.clear();
7122                 }
7123         }
7124         assert_ne!(feerate_2, 0);
7125
7126         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7127         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
7128         let penalty_3;
7129         let mut feerate_3 = 0;
7130         {
7131                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7132                 assert_eq!(node_txn.len(), 1);
7133                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7134                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7135                         assert_eq!(node_txn[0].output.len(), 1);
7136                         check_spends!(node_txn[0], revoked_txn[0]);
7137                         penalty_3 = node_txn[0].txid();
7138                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7139                         assert_ne!(penalty_3, penalty_2);
7140                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7141                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7142                         // Verify 25% bump heuristic
7143                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7144                         node_txn.clear();
7145                 }
7146         }
7147         assert_ne!(feerate_3, 0);
7148
7149         nodes[1].node.get_and_clear_pending_events();
7150         nodes[1].node.get_and_clear_pending_msg_events();
7151 }
7152
7153 #[test]
7154 fn test_bump_penalty_txn_on_revoked_htlcs() {
7155         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7156         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7157
7158         let chanmon_cfgs = create_chanmon_cfgs(2);
7159         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7160         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7161         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7162
7163         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7164         // Lock HTLC in both directions
7165         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7166         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7167
7168         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7169         assert_eq!(revoked_local_txn[0].input.len(), 1);
7170         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7171
7172         // Revoke local commitment tx
7173         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7174
7175         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7176         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7177         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7178         check_closed_broadcast!(nodes[1], false);
7179         check_added_monitors!(nodes[1], 1);
7180
7181         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7182         assert_eq!(revoked_htlc_txn.len(), 4);
7183         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7184                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7185                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7186                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7187                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7188                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7189         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7190                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7191                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7192                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7193                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7194                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7195         }
7196
7197         // Broadcast set of revoked txn on A
7198         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
7199         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7200
7201         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7202         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);
7203         let first;
7204         let feerate_1;
7205         let penalty_txn;
7206         {
7207                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7208                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7209                 // Verify claim tx are spending revoked HTLC txn
7210                 assert_eq!(node_txn[4].input.len(), 2);
7211                 assert_eq!(node_txn[4].output.len(), 1);
7212                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7213                 first = node_txn[4].txid();
7214                 // Store both feerates for later comparison
7215                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7216                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7217                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7218                 node_txn.clear();
7219         }
7220
7221         // Connect three more block to see if bumped penalty are issued for HTLC txn
7222         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7223         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7224         {
7225                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7226                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7227
7228                 check_spends!(node_txn[0], revoked_local_txn[0]);
7229                 check_spends!(node_txn[1], revoked_local_txn[0]);
7230
7231                 node_txn.clear();
7232         };
7233
7234         // Few more blocks to confirm penalty txn
7235         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
7236         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7237         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
7238         let node_txn = {
7239                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7240                 assert_eq!(node_txn.len(), 1);
7241
7242                 assert_eq!(node_txn[0].input.len(), 2);
7243                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7244                 // Verify bumped tx is different and 25% bump heuristic
7245                 assert_ne!(first, node_txn[0].txid());
7246                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7247                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7248                 assert!(feerate_2 * 100 > feerate_1 * 125);
7249                 let txn = vec![node_txn[0].clone()];
7250                 node_txn.clear();
7251                 txn
7252         };
7253         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7254         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7255         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
7256         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
7257         {
7258                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7259                 // We verify than no new transaction has been broadcast because previously
7260                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7261                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7262                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7263                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7264                 // up bumped justice generation.
7265                 assert_eq!(node_txn.len(), 0);
7266                 node_txn.clear();
7267         }
7268         check_closed_broadcast!(nodes[0], false);
7269         check_added_monitors!(nodes[0], 1);
7270 }
7271
7272 #[test]
7273 fn test_bump_penalty_txn_on_remote_commitment() {
7274         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7275         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7276
7277         // Create 2 HTLCs
7278         // Provide preimage for one
7279         // Check aggregation
7280
7281         let chanmon_cfgs = create_chanmon_cfgs(2);
7282         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7283         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7284         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7285
7286         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7287         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7288         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7289
7290         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7291         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7292         assert_eq!(remote_txn[0].output.len(), 4);
7293         assert_eq!(remote_txn[0].input.len(), 1);
7294         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7295
7296         // Claim a HTLC without revocation (provide B monitor with preimage)
7297         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7298         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7299         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7300         check_added_monitors!(nodes[1], 2);
7301
7302         // One or more claim tx should have been broadcast, check it
7303         let timeout;
7304         let preimage;
7305         let feerate_timeout;
7306         let feerate_preimage;
7307         {
7308                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7309                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7310                 assert_eq!(node_txn[0].input.len(), 1);
7311                 assert_eq!(node_txn[1].input.len(), 1);
7312                 check_spends!(node_txn[0], remote_txn[0]);
7313                 check_spends!(node_txn[1], remote_txn[0]);
7314                 check_spends!(node_txn[2], chan.3);
7315                 check_spends!(node_txn[3], node_txn[2]);
7316                 check_spends!(node_txn[4], node_txn[2]);
7317                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7318                         timeout = node_txn[0].txid();
7319                         let index = node_txn[0].input[0].previous_output.vout;
7320                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7321                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7322
7323                         preimage = node_txn[1].txid();
7324                         let index = node_txn[1].input[0].previous_output.vout;
7325                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7326                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7327                 } else {
7328                         timeout = node_txn[1].txid();
7329                         let index = node_txn[1].input[0].previous_output.vout;
7330                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7331                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7332
7333                         preimage = node_txn[0].txid();
7334                         let index = node_txn[0].input[0].previous_output.vout;
7335                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7336                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7337                 }
7338                 node_txn.clear();
7339         };
7340         assert_ne!(feerate_timeout, 0);
7341         assert_ne!(feerate_preimage, 0);
7342
7343         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7344         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
7345         {
7346                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7347                 assert_eq!(node_txn.len(), 2);
7348                 assert_eq!(node_txn[0].input.len(), 1);
7349                 assert_eq!(node_txn[1].input.len(), 1);
7350                 check_spends!(node_txn[0], remote_txn[0]);
7351                 check_spends!(node_txn[1], remote_txn[0]);
7352                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7353                         let index = node_txn[0].input[0].previous_output.vout;
7354                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7355                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7356                         assert!(new_feerate * 100 > feerate_timeout * 125);
7357                         assert_ne!(timeout, node_txn[0].txid());
7358
7359                         let index = node_txn[1].input[0].previous_output.vout;
7360                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7361                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7362                         assert!(new_feerate * 100 > feerate_preimage * 125);
7363                         assert_ne!(preimage, node_txn[1].txid());
7364                 } else {
7365                         let index = node_txn[1].input[0].previous_output.vout;
7366                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7367                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7368                         assert!(new_feerate * 100 > feerate_timeout * 125);
7369                         assert_ne!(timeout, node_txn[1].txid());
7370
7371                         let index = node_txn[0].input[0].previous_output.vout;
7372                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7373                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7374                         assert!(new_feerate * 100 > feerate_preimage * 125);
7375                         assert_ne!(preimage, node_txn[0].txid());
7376                 }
7377                 node_txn.clear();
7378         }
7379
7380         nodes[1].node.get_and_clear_pending_events();
7381         nodes[1].node.get_and_clear_pending_msg_events();
7382 }
7383
7384 #[test]
7385 fn test_set_outpoints_partial_claiming() {
7386         // - remote party claim tx, new bump tx
7387         // - disconnect remote claiming tx, new bump
7388         // - disconnect tx, see no tx anymore
7389         let chanmon_cfgs = create_chanmon_cfgs(2);
7390         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7391         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7392         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7393
7394         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7395         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7396         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7397
7398         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7399         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
7400         assert_eq!(remote_txn.len(), 3);
7401         assert_eq!(remote_txn[0].output.len(), 4);
7402         assert_eq!(remote_txn[0].input.len(), 1);
7403         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7404         check_spends!(remote_txn[1], remote_txn[0]);
7405         check_spends!(remote_txn[2], remote_txn[0]);
7406
7407         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7408         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7409         // Provide node A with both preimage
7410         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
7411         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
7412         check_added_monitors!(nodes[0], 2);
7413         nodes[0].node.get_and_clear_pending_events();
7414         nodes[0].node.get_and_clear_pending_msg_events();
7415
7416         // Connect blocks on node A commitment transaction
7417         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7418         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7419         check_closed_broadcast!(nodes[0], false);
7420         check_added_monitors!(nodes[0], 1);
7421         // Verify node A broadcast tx claiming both HTLCs
7422         {
7423                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7424                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7425                 assert_eq!(node_txn.len(), 4);
7426                 check_spends!(node_txn[0], remote_txn[0]);
7427                 check_spends!(node_txn[1], chan.3);
7428                 check_spends!(node_txn[2], node_txn[1]);
7429                 check_spends!(node_txn[3], node_txn[1]);
7430                 assert_eq!(node_txn[0].input.len(), 2);
7431                 node_txn.clear();
7432         }
7433
7434         // Connect blocks on node B
7435         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7436         check_closed_broadcast!(nodes[1], false);
7437         check_added_monitors!(nodes[1], 1);
7438         // Verify node B broadcast 2 HTLC-timeout txn
7439         let partial_claim_tx = {
7440                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7441                 assert_eq!(node_txn.len(), 3);
7442                 check_spends!(node_txn[1], node_txn[0]);
7443                 check_spends!(node_txn[2], node_txn[0]);
7444                 assert_eq!(node_txn[1].input.len(), 1);
7445                 assert_eq!(node_txn[2].input.len(), 1);
7446                 node_txn[1].clone()
7447         };
7448
7449         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7450         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7451         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7452         {
7453                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7454                 assert_eq!(node_txn.len(), 1);
7455                 check_spends!(node_txn[0], remote_txn[0]);
7456                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7457                 node_txn.clear();
7458         }
7459         nodes[0].node.get_and_clear_pending_msg_events();
7460
7461         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7462         nodes[0].block_notifier.block_disconnected(&header, 102);
7463         {
7464                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7465                 assert_eq!(node_txn.len(), 1);
7466                 check_spends!(node_txn[0], remote_txn[0]);
7467                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7468                 node_txn.clear();
7469         }
7470
7471         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7472         nodes[0].block_notifier.block_disconnected(&header, 101);
7473         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7474         {
7475                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7476                 assert_eq!(node_txn.len(), 0);
7477                 node_txn.clear();
7478         }
7479 }
7480
7481 #[test]
7482 fn test_counterparty_raa_skip_no_crash() {
7483         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7484         // commitment transaction, we would have happily carried on and provided them the next
7485         // commitment transaction based on one RAA forward. This would probably eventually have led to
7486         // channel closure, but it would not have resulted in funds loss. Still, our
7487         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7488         // check simply that the channel is closed in response to such an RAA, but don't check whether
7489         // we decide to punish our counterparty for revoking their funds (as we don't currently
7490         // implement that).
7491         let chanmon_cfgs = create_chanmon_cfgs(2);
7492         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7493         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7494         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7495         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7496
7497         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7498         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7499         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7500                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7501         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7502
7503         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7504                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7505         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7506         check_added_monitors!(nodes[1], 1);
7507 }
7508
7509 #[test]
7510 fn test_bump_txn_sanitize_tracking_maps() {
7511         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7512         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7513
7514         let chanmon_cfgs = create_chanmon_cfgs(2);
7515         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7516         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7517         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7518
7519         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7520         // Lock HTLC in both directions
7521         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7522         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7523
7524         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7525         assert_eq!(revoked_local_txn[0].input.len(), 1);
7526         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7527
7528         // Revoke local commitment tx
7529         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7530
7531         // Broadcast set of revoked txn on A
7532         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7533         expect_pending_htlcs_forwardable_ignore!(nodes[0]);
7534
7535         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7536         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7537         check_closed_broadcast!(nodes[0], false);
7538         check_added_monitors!(nodes[0], 1);
7539         let penalty_txn = {
7540                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7541                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7542                 check_spends!(node_txn[0], revoked_local_txn[0]);
7543                 check_spends!(node_txn[1], revoked_local_txn[0]);
7544                 check_spends!(node_txn[2], revoked_local_txn[0]);
7545                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7546                 node_txn.clear();
7547                 penalty_txn
7548         };
7549         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7550         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7551         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7552         {
7553                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7554                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7555                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
7556                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
7557                 }
7558         }
7559 }
7560
7561 #[test]
7562 fn test_override_channel_config() {
7563         let chanmon_cfgs = create_chanmon_cfgs(2);
7564         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7565         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7566         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7567
7568         // Node0 initiates a channel to node1 using the override config.
7569         let mut override_config = UserConfig::default();
7570         override_config.own_channel_config.our_to_self_delay = 200;
7571
7572         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7573
7574         // Assert the channel created by node0 is using the override config.
7575         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7576         assert_eq!(res.channel_flags, 0);
7577         assert_eq!(res.to_self_delay, 200);
7578 }
7579
7580 #[test]
7581 fn test_override_0msat_htlc_minimum() {
7582         let mut zero_config = UserConfig::default();
7583         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
7584         let chanmon_cfgs = create_chanmon_cfgs(2);
7585         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7586         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7587         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7588
7589         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7590         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7591         assert_eq!(res.htlc_minimum_msat, 1);
7592
7593         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &res);
7594         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7595         assert_eq!(res.htlc_minimum_msat, 1);
7596 }
7597
7598 #[test]
7599 fn test_simple_payment_secret() {
7600         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
7601         // features, however.
7602         let chanmon_cfgs = create_chanmon_cfgs(3);
7603         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7604         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7605         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7606
7607         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
7608         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
7609
7610         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7611         let payment_secret = PaymentSecret([0xdb; 32]);
7612         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7613         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
7614         // Claiming with all the correct values but the wrong secret should result in nothing...
7615         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
7616         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
7617         // ...but with the right secret we should be able to claim all the way back
7618         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
7619 }
7620
7621 #[test]
7622 fn test_simple_mpp() {
7623         // Simple test of sending a multi-path payment.
7624         let chanmon_cfgs = create_chanmon_cfgs(4);
7625         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7626         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7627         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7628
7629         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7630         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7631         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7632         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7633
7634         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7635         let payment_secret = PaymentSecret([0xdb; 32]);
7636         let mut route = nodes[0].router.get_route(&nodes[3].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7637         let path = route.paths[0].clone();
7638         route.paths.push(path);
7639         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7640         route.paths[0][0].short_channel_id = chan_1_id;
7641         route.paths[0][1].short_channel_id = chan_3_id;
7642         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7643         route.paths[1][0].short_channel_id = chan_2_id;
7644         route.paths[1][1].short_channel_id = chan_4_id;
7645         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
7646         // Claiming with all the correct values but the wrong secret should result in nothing...
7647         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
7648         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
7649         // ...but with the right secret we should be able to claim all the way back
7650         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
7651 }
7652
7653 #[test]
7654 fn test_update_err_monitor_lockdown() {
7655         // Our monitor will lock update of local commitment transaction if a broadcastion condition
7656         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
7657         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
7658         //
7659         // This scenario may happen in a watchtower setup, where watchtower process a block height
7660         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
7661         // commitment at same time.
7662
7663         let chanmon_cfgs = create_chanmon_cfgs(2);
7664         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7665         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7666         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7667
7668         // Create some initial channel
7669         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
7670         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
7671
7672         // Rebalance the network to generate htlc in the two directions
7673         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
7674
7675         // Route a HTLC from node 0 to node 1 (but don't settle)
7676         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7677
7678         // Copy SimpleManyChannelMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
7679         let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
7680         let watchtower = {
7681                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7682                 let monitor = monitors.get(&outpoint).unwrap();
7683                 let mut w = test_utils::TestVecWriter(Vec::new());
7684                 monitor.write_for_disk(&mut w).unwrap();
7685                 let new_monitor = <(Sha256dHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
7686                                 &mut ::std::io::Cursor::new(&w.0), Arc::new(test_utils::TestLogger::new())).unwrap().1;
7687                 assert!(new_monitor == *monitor);
7688                 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, logger.clone() as Arc<Logger>));
7689                 let watchtower = test_utils::TestChannelMonitor::new(chain_monitor, &chanmon_cfgs[0].tx_broadcaster, logger.clone(), &chanmon_cfgs[0].fee_estimator);
7690                 assert!(watchtower.add_monitor(outpoint, new_monitor).is_ok());
7691                 watchtower
7692         };
7693         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7694         watchtower.simple_monitor.block_connected(&header, 200, &vec![], &vec![]);
7695
7696         // Try to update ChannelMonitor
7697         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
7698         check_added_monitors!(nodes[1], 1);
7699         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7700         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
7701         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
7702         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
7703                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator) {
7704                         if let Err(_) =  watchtower.simple_monitor.update_monitor(outpoint, update.clone()) {} else { assert!(false); }
7705                         if let Ok(_) = nodes[0].chan_monitor.update_monitor(outpoint, update) {} else { assert!(false); }
7706                 } else { assert!(false); }
7707         } else { assert!(false); };
7708         // Our local monitor is in-sync and hasn't processed yet timeout
7709         check_added_monitors!(nodes[0], 1);
7710         let events = nodes[0].node.get_and_clear_pending_events();
7711         assert_eq!(events.len(), 1);
7712 }