_ 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         {
 455                 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 456                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 457                 assert_eq!(added_monitors.len(), 1);
 458                 assert_eq!(added_monitors[0].0, funding_output);
 459                 added_monitors.clear();
 460         }
 461         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 462
 463         if steps & 0x0f == 4 { return; }
 464         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 465         {
 466                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
 467                 assert_eq!(added_monitors.len(), 1);
 468                 assert_eq!(added_monitors[0].0, funding_output);
 469                 added_monitors.clear();
 470         }
 471         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 472
 473         if steps & 0x0f == 5 { return; }
 474         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 475         {
 476                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 477                 assert_eq!(added_monitors.len(), 1);
 478                 assert_eq!(added_monitors[0].0, funding_output);
 479                 added_monitors.clear();
 480         }
 481
 482         let events_4 = nodes[0].node.get_and_clear_pending_events();
 483         assert_eq!(events_4.len(), 1);
 484         match events_4[0] {
 485                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 486                         assert_eq!(user_channel_id, 42);
 487                         assert_eq!(*funding_txo, funding_output);
 488                 },
 489                 _ => panic!("Unexpected event"),
 490         };
 491
 492         if steps & 0x0f == 6 { return; }
 493         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 494
 495         if steps & 0x0f == 7 { return; }
 496         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
 497         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 498 }
 499
 500 #[test]
 501 fn test_sanity_on_in_flight_opens() {
 502         do_test_sanity_on_in_flight_opens(0);
 503         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 504         do_test_sanity_on_in_flight_opens(1);
 505         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 506         do_test_sanity_on_in_flight_opens(2);
 507         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 508         do_test_sanity_on_in_flight_opens(3);
 509         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 510         do_test_sanity_on_in_flight_opens(4);
 511         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 512         do_test_sanity_on_in_flight_opens(5);
 513         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 514         do_test_sanity_on_in_flight_opens(6);
 515         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 516         do_test_sanity_on_in_flight_opens(7);
 517         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 518         do_test_sanity_on_in_flight_opens(8);
 519         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 520 }
 521
 522 #[test]
 523 fn test_update_fee_vanilla() {
 524         let chanmon_cfgs = create_chanmon_cfgs(2);
 525         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 526         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 527         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 528         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 529         let channel_id = chan.2;
 530
 531         let feerate = get_feerate!(nodes[0], channel_id);
 532         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 533         check_added_monitors!(nodes[0], 1);
 534
 535         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 536         assert_eq!(events_0.len(), 1);
 537         let (update_msg, commitment_signed) = match events_0[0] {
 538                         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 } } => {
 539                         (update_fee.as_ref(), commitment_signed)
 540                 },
 541                 _ => panic!("Unexpected event"),
 542         };
 543         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 544
 545         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 546         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 547         check_added_monitors!(nodes[1], 1);
 548
 549         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 550         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 551         check_added_monitors!(nodes[0], 1);
 552
 553         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 554         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 555         // No commitment_signed so get_event_msg's assert(len == 1) passes
 556         check_added_monitors!(nodes[0], 1);
 557
 558         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 559         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 560         check_added_monitors!(nodes[1], 1);
 561 }
 562
 563 #[test]
 564 fn test_update_fee_that_funder_cannot_afford() {
 565         let chanmon_cfgs = create_chanmon_cfgs(2);
 566         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 567         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 568         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 569         let channel_value = 1888;
 570         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::supported(), InitFeatures::supported());
 571         let channel_id = chan.2;
 572
 573         let feerate = 260;
 574         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 575         check_added_monitors!(nodes[0], 1);
 576         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 577
 578         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 579
 580         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 581
 582         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 583         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 584         {
 585                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 586
 587                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 588                 let num_htlcs = commitment_tx.output.len() - 2;
 589                 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 590                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 591                 actual_fee = channel_value - actual_fee;
 592                 assert_eq!(total_fee, actual_fee);
 593         }
 594
 595         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 596         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 597         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 598         check_added_monitors!(nodes[0], 1);
 599
 600         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 601
 602         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 603
 604         //While producing the commitment_signed response after handling a received update_fee request the
 605         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 606         //Should produce and error.
 607         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 608         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 609         check_added_monitors!(nodes[1], 1);
 610         check_closed_broadcast!(nodes[1], true);
 611 }
 612
 613 #[test]
 614 fn test_update_fee_with_fundee_update_add_htlc() {
 615         let chanmon_cfgs = create_chanmon_cfgs(2);
 616         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 617         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 618         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 619         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 620         let channel_id = chan.2;
 621
 622         // balancing
 623         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 624
 625         let feerate = get_feerate!(nodes[0], channel_id);
 626         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 627         check_added_monitors!(nodes[0], 1);
 628
 629         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 630         assert_eq!(events_0.len(), 1);
 631         let (update_msg, commitment_signed) = match events_0[0] {
 632                         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 } } => {
 633                         (update_fee.as_ref(), commitment_signed)
 634                 },
 635                 _ => panic!("Unexpected event"),
 636         };
 637         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 638         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 639         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 640         check_added_monitors!(nodes[1], 1);
 641
 642         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
 643
 644         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 645
 646         // nothing happens since node[1] is in AwaitingRemoteRevoke
 647         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
 648         {
 649                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 650                 assert_eq!(added_monitors.len(), 0);
 651                 added_monitors.clear();
 652         }
 653         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 654         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 655         // node[1] has nothing to do
 656
 657         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 658         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 659         check_added_monitors!(nodes[0], 1);
 660
 661         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 662         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 663         // No commitment_signed so get_event_msg's assert(len == 1) passes
 664         check_added_monitors!(nodes[0], 1);
 665         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 666         check_added_monitors!(nodes[1], 1);
 667         // AwaitingRemoteRevoke ends here
 668
 669         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 670         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 671         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 672         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 673         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 674         assert_eq!(commitment_update.update_fee.is_none(), true);
 675
 676         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 677         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 678         check_added_monitors!(nodes[0], 1);
 679         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 680
 681         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 682         check_added_monitors!(nodes[1], 1);
 683         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 684
 685         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 686         check_added_monitors!(nodes[1], 1);
 687         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 688         // No commitment_signed so get_event_msg's assert(len == 1) passes
 689
 690         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 691         check_added_monitors!(nodes[0], 1);
 692         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 693
 694         expect_pending_htlcs_forwardable!(nodes[0]);
 695
 696         let events = nodes[0].node.get_and_clear_pending_events();
 697         assert_eq!(events.len(), 1);
 698         match events[0] {
 699                 Event::PaymentReceived { .. } => { },
 700                 _ => panic!("Unexpected event"),
 701         };
 702
 703         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 704
 705         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 706         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 707         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 708 }
 709
 710 #[test]
 711 fn test_update_fee() {
 712         let chanmon_cfgs = create_chanmon_cfgs(2);
 713         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 714         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 715         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 716         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 717         let channel_id = chan.2;
 718
 719         // A                                        B
 720         // (1) update_fee/commitment_signed      ->
 721         //                                       <- (2) revoke_and_ack
 722         //                                       .- send (3) commitment_signed
 723         // (4) update_fee/commitment_signed      ->
 724         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 725         //                                       <- (3) commitment_signed delivered
 726         // send (6) revoke_and_ack               -.
 727         //                                       <- (5) deliver revoke_and_ack
 728         // (6) deliver revoke_and_ack            ->
 729         //                                       .- send (7) commitment_signed in response to (4)
 730         //                                       <- (7) deliver commitment_signed
 731         // revoke_and_ack                        ->
 732
 733         // Create and deliver (1)...
 734         let feerate = get_feerate!(nodes[0], channel_id);
 735         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 736         check_added_monitors!(nodes[0], 1);
 737
 738         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 739         assert_eq!(events_0.len(), 1);
 740         let (update_msg, commitment_signed) = match events_0[0] {
 741                         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 } } => {
 742                         (update_fee.as_ref(), commitment_signed)
 743                 },
 744                 _ => panic!("Unexpected event"),
 745         };
 746         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 747
 748         // Generate (2) and (3):
 749         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 750         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 751         check_added_monitors!(nodes[1], 1);
 752
 753         // Deliver (2):
 754         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 755         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 756         check_added_monitors!(nodes[0], 1);
 757
 758         // Create and deliver (4)...
 759         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 760         check_added_monitors!(nodes[0], 1);
 761         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 762         assert_eq!(events_0.len(), 1);
 763         let (update_msg, commitment_signed) = match events_0[0] {
 764                         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 } } => {
 765                         (update_fee.as_ref(), commitment_signed)
 766                 },
 767                 _ => panic!("Unexpected event"),
 768         };
 769
 770         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 771         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 772         check_added_monitors!(nodes[1], 1);
 773         // ... creating (5)
 774         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 775         // No commitment_signed so get_event_msg's assert(len == 1) passes
 776
 777         // Handle (3), creating (6):
 778         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 779         check_added_monitors!(nodes[0], 1);
 780         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 781         // No commitment_signed so get_event_msg's assert(len == 1) passes
 782
 783         // Deliver (5):
 784         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 785         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 786         check_added_monitors!(nodes[0], 1);
 787
 788         // Deliver (6), creating (7):
 789         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 790         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 791         assert!(commitment_update.update_add_htlcs.is_empty());
 792         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 793         assert!(commitment_update.update_fail_htlcs.is_empty());
 794         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 795         assert!(commitment_update.update_fee.is_none());
 796         check_added_monitors!(nodes[1], 1);
 797
 798         // Deliver (7)
 799         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 800         check_added_monitors!(nodes[0], 1);
 801         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 802         // No commitment_signed so get_event_msg's assert(len == 1) passes
 803
 804         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 805         check_added_monitors!(nodes[1], 1);
 806         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 807
 808         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 809         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 810         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 811 }
 812
 813 #[test]
 814 fn pre_funding_lock_shutdown_test() {
 815         // Test sending a shutdown prior to funding_locked after funding generation
 816         let chanmon_cfgs = create_chanmon_cfgs(2);
 817         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 818         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 819         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 820         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::supported(), InitFeatures::supported());
 821         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 822         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 823         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 824
 825         nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
 826         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 827         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 828         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 829         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 830
 831         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 832         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 833         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 834         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 835         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 836         assert!(node_0_none.is_none());
 837
 838         assert!(nodes[0].node.list_channels().is_empty());
 839         assert!(nodes[1].node.list_channels().is_empty());
 840 }
 841
 842 #[test]
 843 fn updates_shutdown_wait() {
 844         // Test sending a shutdown with outstanding updates pending
 845         let chanmon_cfgs = create_chanmon_cfgs(3);
 846         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 847         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 848         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 849         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 850         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 851         let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 852         let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 853
 854         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 855
 856         nodes[0].node.close_channel(&chan_1.2).unwrap();
 857         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 858         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 859         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 860         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 861
 862         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 863         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 864
 865         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 866         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 867         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 868
 869         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 870         check_added_monitors!(nodes[2], 1);
 871         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 872         assert!(updates.update_add_htlcs.is_empty());
 873         assert!(updates.update_fail_htlcs.is_empty());
 874         assert!(updates.update_fail_malformed_htlcs.is_empty());
 875         assert!(updates.update_fee.is_none());
 876         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 877         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 878         check_added_monitors!(nodes[1], 1);
 879         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 880         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 881
 882         assert!(updates_2.update_add_htlcs.is_empty());
 883         assert!(updates_2.update_fail_htlcs.is_empty());
 884         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 885         assert!(updates_2.update_fee.is_none());
 886         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 887         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 888         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 889
 890         let events = nodes[0].node.get_and_clear_pending_events();
 891         assert_eq!(events.len(), 1);
 892         match events[0] {
 893                 Event::PaymentSent { ref payment_preimage } => {
 894                         assert_eq!(our_payment_preimage, *payment_preimage);
 895                 },
 896                 _ => panic!("Unexpected event"),
 897         }
 898
 899         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 900         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 901         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 902         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 903         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 904         assert!(node_0_none.is_none());
 905
 906         assert!(nodes[0].node.list_channels().is_empty());
 907
 908         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 909         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 910         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 911         assert!(nodes[1].node.list_channels().is_empty());
 912         assert!(nodes[2].node.list_channels().is_empty());
 913 }
 914
 915 #[test]
 916 fn htlc_fail_async_shutdown() {
 917         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 918         let chanmon_cfgs = create_chanmon_cfgs(3);
 919         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 920         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 921         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 922         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 923         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 924
 925         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 926         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 927         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 928         check_added_monitors!(nodes[0], 1);
 929         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 930         assert_eq!(updates.update_add_htlcs.len(), 1);
 931         assert!(updates.update_fulfill_htlcs.is_empty());
 932         assert!(updates.update_fail_htlcs.is_empty());
 933         assert!(updates.update_fail_malformed_htlcs.is_empty());
 934         assert!(updates.update_fee.is_none());
 935
 936         nodes[1].node.close_channel(&chan_1.2).unwrap();
 937         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 938         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 939         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 940
 941         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 942         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 943         check_added_monitors!(nodes[1], 1);
 944         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 945         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 946
 947         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 948         assert!(updates_2.update_add_htlcs.is_empty());
 949         assert!(updates_2.update_fulfill_htlcs.is_empty());
 950         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 951         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 952         assert!(updates_2.update_fee.is_none());
 953
 954         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 955         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 956
 957         let events = nodes[0].node.get_and_clear_pending_events();
 958         assert_eq!(events.len(), 1);
 959         match events[0] {
 960                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
 961                         assert_eq!(our_payment_hash, *payment_hash);
 962                         assert!(!rejected_by_dest);
 963                 },
 964                 _ => panic!("Unexpected event"),
 965         }
 966
 967         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 968         assert_eq!(msg_events.len(), 2);
 969         let node_0_closing_signed = match msg_events[0] {
 970                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 971                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 972                         (*msg).clone()
 973                 },
 974                 _ => panic!("Unexpected event"),
 975         };
 976         match msg_events[1] {
 977                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 978                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 979                 },
 980                 _ => panic!("Unexpected event"),
 981         }
 982
 983         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 984         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 985         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 986         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 987         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 988         assert!(node_0_none.is_none());
 989
 990         assert!(nodes[0].node.list_channels().is_empty());
 991
 992         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 993         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 994         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 995         assert!(nodes[1].node.list_channels().is_empty());
 996         assert!(nodes[2].node.list_channels().is_empty());
 997 }
 998
 999 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1000         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1001         // messages delivered prior to disconnect
1002         let chanmon_cfgs = create_chanmon_cfgs(3);
1003         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1004         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1005         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1006         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1007         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1008
1009         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1010
1011         nodes[1].node.close_channel(&chan_1.2).unwrap();
1012         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1013         if recv_count > 0 {
1014                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1015                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1016                 if recv_count > 1 {
1017                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1018                 }
1019         }
1020
1021         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1022         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1023
1024         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1025         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1026         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1027         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1028
1029         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1030         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1031         assert!(node_1_shutdown == node_1_2nd_shutdown);
1032
1033         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1034         let node_0_2nd_shutdown = if recv_count > 0 {
1035                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1036                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1037                 node_0_2nd_shutdown
1038         } else {
1039                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1040                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1041                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1042         };
1043         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1044
1045         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1046         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1047
1048         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1049         check_added_monitors!(nodes[2], 1);
1050         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1051         assert!(updates.update_add_htlcs.is_empty());
1052         assert!(updates.update_fail_htlcs.is_empty());
1053         assert!(updates.update_fail_malformed_htlcs.is_empty());
1054         assert!(updates.update_fee.is_none());
1055         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1056         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1057         check_added_monitors!(nodes[1], 1);
1058         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1059         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1060
1061         assert!(updates_2.update_add_htlcs.is_empty());
1062         assert!(updates_2.update_fail_htlcs.is_empty());
1063         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1064         assert!(updates_2.update_fee.is_none());
1065         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1066         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1067         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1068
1069         let events = nodes[0].node.get_and_clear_pending_events();
1070         assert_eq!(events.len(), 1);
1071         match events[0] {
1072                 Event::PaymentSent { ref payment_preimage } => {
1073                         assert_eq!(our_payment_preimage, *payment_preimage);
1074                 },
1075                 _ => panic!("Unexpected event"),
1076         }
1077
1078         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1079         if recv_count > 0 {
1080                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1081                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1082                 assert!(node_1_closing_signed.is_some());
1083         }
1084
1085         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1086         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1087
1088         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1089         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1090         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1091         if recv_count == 0 {
1092                 // If all closing_signeds weren't delivered we can just resume where we left off...
1093                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1094
1095                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1096                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1097                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1098
1099                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1100                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1101                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1102
1103                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1104                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1105
1106                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1107                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1108                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1109
1110                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1111                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1112                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1113                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1114                 assert!(node_0_none.is_none());
1115         } else {
1116                 // If one node, however, received + responded with an identical closing_signed we end
1117                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1118                 // There isn't really anything better we can do simply, but in the future we might
1119                 // explore storing a set of recently-closed channels that got disconnected during
1120                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1121                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1122                 // transaction.
1123                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1124
1125                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1126                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1127                 assert_eq!(msg_events.len(), 1);
1128                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1129                         match action {
1130                                 &ErrorAction::SendErrorMessage { ref msg } => {
1131                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1132                                         assert_eq!(msg.channel_id, chan_1.2);
1133                                 },
1134                                 _ => panic!("Unexpected event!"),
1135                         }
1136                 } else { panic!("Needed SendErrorMessage close"); }
1137
1138                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1139                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1140                 // closing_signed so we do it ourselves
1141                 check_closed_broadcast!(nodes[0], false);
1142                 check_added_monitors!(nodes[0], 1);
1143         }
1144
1145         assert!(nodes[0].node.list_channels().is_empty());
1146
1147         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1148         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1149         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1150         assert!(nodes[1].node.list_channels().is_empty());
1151         assert!(nodes[2].node.list_channels().is_empty());
1152 }
1153
1154 #[test]
1155 fn test_shutdown_rebroadcast() {
1156         do_test_shutdown_rebroadcast(0);
1157         do_test_shutdown_rebroadcast(1);
1158         do_test_shutdown_rebroadcast(2);
1159 }
1160
1161 #[test]
1162 fn fake_network_test() {
1163         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1164         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1165         let chanmon_cfgs = create_chanmon_cfgs(4);
1166         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1167         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1168         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1169
1170         // Create some initial channels
1171         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1172         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1173         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1174
1175         // Rebalance the network a bit by relaying one payment through all the channels...
1176         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1177         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1178         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1179         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1180
1181         // Send some more payments
1182         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1183         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1184         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1185
1186         // Test failure packets
1187         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1188         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1189
1190         // Add a new channel that skips 3
1191         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1192
1193         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1194         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1195         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1196         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1197         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1198         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1199         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1200
1201         // Do some rebalance loop payments, simultaneously
1202         let mut hops = Vec::with_capacity(3);
1203         hops.push(RouteHop {
1204                 pubkey: nodes[2].node.get_our_node_id(),
1205                 node_features: NodeFeatures::empty(),
1206                 short_channel_id: chan_2.0.contents.short_channel_id,
1207                 channel_features: ChannelFeatures::empty(),
1208                 fee_msat: 0,
1209                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1210         });
1211         hops.push(RouteHop {
1212                 pubkey: nodes[3].node.get_our_node_id(),
1213                 node_features: NodeFeatures::empty(),
1214                 short_channel_id: chan_3.0.contents.short_channel_id,
1215                 channel_features: ChannelFeatures::empty(),
1216                 fee_msat: 0,
1217                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1218         });
1219         hops.push(RouteHop {
1220                 pubkey: nodes[1].node.get_our_node_id(),
1221                 node_features: NodeFeatures::empty(),
1222                 short_channel_id: chan_4.0.contents.short_channel_id,
1223                 channel_features: ChannelFeatures::empty(),
1224                 fee_msat: 1000000,
1225                 cltv_expiry_delta: TEST_FINAL_CLTV,
1226         });
1227         hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1228         hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1229         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1230
1231         let mut hops = Vec::with_capacity(3);
1232         hops.push(RouteHop {
1233                 pubkey: nodes[3].node.get_our_node_id(),
1234                 node_features: NodeFeatures::empty(),
1235                 short_channel_id: chan_4.0.contents.short_channel_id,
1236                 channel_features: ChannelFeatures::empty(),
1237                 fee_msat: 0,
1238                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1239         });
1240         hops.push(RouteHop {
1241                 pubkey: nodes[2].node.get_our_node_id(),
1242                 node_features: NodeFeatures::empty(),
1243                 short_channel_id: chan_3.0.contents.short_channel_id,
1244                 channel_features: ChannelFeatures::empty(),
1245                 fee_msat: 0,
1246                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1247         });
1248         hops.push(RouteHop {
1249                 pubkey: nodes[1].node.get_our_node_id(),
1250                 node_features: NodeFeatures::empty(),
1251                 short_channel_id: chan_2.0.contents.short_channel_id,
1252                 channel_features: ChannelFeatures::empty(),
1253                 fee_msat: 1000000,
1254                 cltv_expiry_delta: TEST_FINAL_CLTV,
1255         });
1256         hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1257         hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1258         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1259
1260         // Claim the rebalances...
1261         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1262         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1263
1264         // Add a duplicate new channel from 2 to 4
1265         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1266
1267         // Send some payments across both channels
1268         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1269         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1270         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1271
1272
1273         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1274         let events = nodes[0].node.get_and_clear_pending_msg_events();
1275         assert_eq!(events.len(), 0);
1276         nodes[0].logger.assert_log("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);
1277
1278         //TODO: Test that routes work again here as we've been notified that the channel is full
1279
1280         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1281         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1282         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1283
1284         // Close down the channels...
1285         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1286         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1287         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1288         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1289         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1290 }
1291
1292 #[test]
1293 fn holding_cell_htlc_counting() {
1294         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1295         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1296         // commitment dance rounds.
1297         let chanmon_cfgs = create_chanmon_cfgs(3);
1298         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1299         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1300         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1301         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1302         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1303
1304         let mut payments = Vec::new();
1305         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1306                 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1307                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1308                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1309                 payments.push((payment_preimage, payment_hash));
1310         }
1311         check_added_monitors!(nodes[1], 1);
1312
1313         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1314         assert_eq!(events.len(), 1);
1315         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1316         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1317
1318         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1319         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1320         // another HTLC.
1321         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1322         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1323         unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { err },
1324                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
1325         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1326         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1327
1328         // This should also be true if we try to forward a payment.
1329         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1330         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1331         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1332         check_added_monitors!(nodes[0], 1);
1333
1334         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1335         assert_eq!(events.len(), 1);
1336         let payment_event = SendEvent::from_event(events.pop().unwrap());
1337         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1338
1339         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1340         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1341         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1342         // fails), the second will process the resulting failure and fail the HTLC backward.
1343         expect_pending_htlcs_forwardable!(nodes[1]);
1344         expect_pending_htlcs_forwardable!(nodes[1]);
1345         check_added_monitors!(nodes[1], 1);
1346
1347         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1348         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1349         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1350
1351         let events = nodes[0].node.get_and_clear_pending_msg_events();
1352         assert_eq!(events.len(), 1);
1353         match events[0] {
1354                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1355                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1356                 },
1357                 _ => panic!("Unexpected event"),
1358         }
1359
1360         let events = nodes[0].node.get_and_clear_pending_events();
1361         assert_eq!(events.len(), 1);
1362         match events[0] {
1363                 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1364                         assert_eq!(payment_hash, payment_hash_2);
1365                         assert!(!rejected_by_dest);
1366                 },
1367                 _ => panic!("Unexpected event"),
1368         }
1369
1370         // Now forward all the pending HTLCs and claim them back
1371         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1372         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1373         check_added_monitors!(nodes[2], 1);
1374
1375         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1376         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1377         check_added_monitors!(nodes[1], 1);
1378         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1379
1380         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1381         check_added_monitors!(nodes[1], 1);
1382         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1383
1384         for ref update in as_updates.update_add_htlcs.iter() {
1385                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1386         }
1387         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1388         check_added_monitors!(nodes[2], 1);
1389         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1390         check_added_monitors!(nodes[2], 1);
1391         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1392
1393         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1394         check_added_monitors!(nodes[1], 1);
1395         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1396         check_added_monitors!(nodes[1], 1);
1397         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1398
1399         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1400         check_added_monitors!(nodes[2], 1);
1401
1402         expect_pending_htlcs_forwardable!(nodes[2]);
1403
1404         let events = nodes[2].node.get_and_clear_pending_events();
1405         assert_eq!(events.len(), payments.len());
1406         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1407                 match event {
1408                         &Event::PaymentReceived { ref payment_hash, .. } => {
1409                                 assert_eq!(*payment_hash, *hash);
1410                         },
1411                         _ => panic!("Unexpected event"),
1412                 };
1413         }
1414
1415         for (preimage, _) in payments.drain(..) {
1416                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1417         }
1418
1419         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1420 }
1421
1422 #[test]
1423 fn duplicate_htlc_test() {
1424         // Test that we accept duplicate payment_hash HTLCs across the network and that
1425         // claiming/failing them are all separate and don't affect each other
1426         let chanmon_cfgs = create_chanmon_cfgs(6);
1427         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1428         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1429         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1430
1431         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1432         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1433         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1434         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1435         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1436         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1437
1438         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1439
1440         *nodes[0].network_payment_count.borrow_mut() -= 1;
1441         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1442
1443         *nodes[0].network_payment_count.borrow_mut() -= 1;
1444         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1445
1446         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1447         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1448         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1449 }
1450
1451 #[test]
1452 fn test_duplicate_htlc_different_direction_onchain() {
1453         // Test that ChannelMonitor doesn't generate 2 preimage txn
1454         // when we have 2 HTLCs with same preimage that go across a node
1455         // in opposite directions.
1456         let chanmon_cfgs = create_chanmon_cfgs(2);
1457         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1458         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1459         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1460
1461         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1462
1463         // balancing
1464         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1465
1466         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1467
1468         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1469         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1470
1471         // Provide preimage to node 0 by claiming payment
1472         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1473         check_added_monitors!(nodes[0], 1);
1474
1475         // Broadcast node 1 commitment txn
1476         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1477
1478         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1479         let mut has_both_htlcs = 0; // check htlcs match ones committed
1480         for outp in remote_txn[0].output.iter() {
1481                 if outp.value == 800_000 / 1000 {
1482                         has_both_htlcs += 1;
1483                 } else if outp.value == 900_000 / 1000 {
1484                         has_both_htlcs += 1;
1485                 }
1486         }
1487         assert_eq!(has_both_htlcs, 2);
1488
1489         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1490         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1491         check_added_monitors!(nodes[0], 1);
1492
1493         // Check we only broadcast 1 timeout tx
1494         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1495         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()) };
1496         assert_eq!(claim_txn.len(), 5);
1497         check_spends!(claim_txn[2], chan_1.3);
1498         check_spends!(claim_txn[3], claim_txn[2]);
1499         assert_eq!(htlc_pair.0.input.len(), 1);
1500         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1501         check_spends!(htlc_pair.0, remote_txn[0]);
1502         assert_eq!(htlc_pair.1.input.len(), 1);
1503         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1504         check_spends!(htlc_pair.1, remote_txn[0]);
1505
1506         let events = nodes[0].node.get_and_clear_pending_msg_events();
1507         assert_eq!(events.len(), 2);
1508         for e in events {
1509                 match e {
1510                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1511                         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, .. } } => {
1512                                 assert!(update_add_htlcs.is_empty());
1513                                 assert!(update_fail_htlcs.is_empty());
1514                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1515                                 assert!(update_fail_malformed_htlcs.is_empty());
1516                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1517                         },
1518                         _ => panic!("Unexpected event"),
1519                 }
1520         }
1521 }
1522
1523 fn do_channel_reserve_test(test_recv: bool) {
1524
1525         let chanmon_cfgs = create_chanmon_cfgs(3);
1526         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1527         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1528         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1529         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1530         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1531
1532         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1533         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1534
1535         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1536         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1537
1538         macro_rules! get_route_and_payment_hash {
1539                 ($recv_value: expr) => {{
1540                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1541                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1542                         (route, payment_hash, payment_preimage)
1543                 }}
1544         };
1545
1546         macro_rules! expect_forward {
1547                 ($node: expr) => {{
1548                         let mut events = $node.node.get_and_clear_pending_msg_events();
1549                         assert_eq!(events.len(), 1);
1550                         check_added_monitors!($node, 1);
1551                         let payment_event = SendEvent::from_event(events.remove(0));
1552                         payment_event
1553                 }}
1554         }
1555
1556         let feemsat = 239; // somehow we know?
1557         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1558
1559         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1560
1561         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1562         {
1563                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1564                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1565                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1566                         assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
1567                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1568                 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);
1569         }
1570
1571         let mut htlc_id = 0;
1572         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1573         // nodes[0]'s wealth
1574         loop {
1575                 let amt_msat = recv_value_0 + total_fee_msat;
1576                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1577                         break;
1578                 }
1579                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1580                 htlc_id += 1;
1581
1582                 let (stat01_, stat11_, stat12_, stat22_) = (
1583                         get_channel_value_stat!(nodes[0], chan_1.2),
1584                         get_channel_value_stat!(nodes[1], chan_1.2),
1585                         get_channel_value_stat!(nodes[1], chan_2.2),
1586                         get_channel_value_stat!(nodes[2], chan_2.2),
1587                 );
1588
1589                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1590                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1591                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1592                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1593                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1594         }
1595
1596         {
1597                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1598                 // attempt to get channel_reserve violation
1599                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1600                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1601                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1602                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1603                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1604         }
1605
1606         // adding pending output
1607         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1608         let amt_msat_1 = recv_value_1 + total_fee_msat;
1609
1610         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1611         let payment_event_1 = {
1612                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1613                 check_added_monitors!(nodes[0], 1);
1614
1615                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1616                 assert_eq!(events.len(), 1);
1617                 SendEvent::from_event(events.remove(0))
1618         };
1619         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1620
1621         // channel reserve test with htlc pending output > 0
1622         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1623         {
1624                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1625                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1626                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1627                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1628                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1629         }
1630
1631         {
1632                 // test channel_reserve test on nodes[1] side
1633                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1634
1635                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1636                 let secp_ctx = Secp256k1::new();
1637                 let session_priv = SecretKey::from_slice(&{
1638                         let mut session_key = [0; 32];
1639                         let mut rng = thread_rng();
1640                         rng.fill_bytes(&mut session_key);
1641                         session_key
1642                 }).expect("RNG is bad!");
1643
1644                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1645                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1646                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], recv_value_2 + 1, &None, cur_height).unwrap();
1647                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1648                 let msg = msgs::UpdateAddHTLC {
1649                         channel_id: chan_1.2,
1650                         htlc_id,
1651                         amount_msat: htlc_msat,
1652                         payment_hash: our_payment_hash,
1653                         cltv_expiry: htlc_cltv,
1654                         onion_routing_packet: onion_packet,
1655                 };
1656
1657                 if test_recv {
1658                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1659                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1660                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1661                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1662                         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1663                         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1664                         check_added_monitors!(nodes[1], 1);
1665                         return;
1666                 }
1667         }
1668
1669         // split the rest to test holding cell
1670         let recv_value_21 = recv_value_2/2;
1671         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1672         {
1673                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1674                 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);
1675         }
1676
1677         // now see if they go through on both sides
1678         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1679         // but this will stuck in the holding cell
1680         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
1681         check_added_monitors!(nodes[0], 0);
1682         let events = nodes[0].node.get_and_clear_pending_events();
1683         assert_eq!(events.len(), 0);
1684
1685         // test with outbound holding cell amount > 0
1686         {
1687                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1688                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1689                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1690                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1691                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1692         }
1693
1694         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1695         // this will also stuck in the holding cell
1696         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
1697         check_added_monitors!(nodes[0], 0);
1698         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1699         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1700
1701         // flush the pending htlc
1702         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1703         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1704         check_added_monitors!(nodes[1], 1);
1705
1706         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1707         check_added_monitors!(nodes[0], 1);
1708         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1709
1710         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1711         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1712         // No commitment_signed so get_event_msg's assert(len == 1) passes
1713         check_added_monitors!(nodes[0], 1);
1714
1715         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1716         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1717         check_added_monitors!(nodes[1], 1);
1718
1719         expect_pending_htlcs_forwardable!(nodes[1]);
1720
1721         let ref payment_event_11 = expect_forward!(nodes[1]);
1722         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1723         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1724
1725         expect_pending_htlcs_forwardable!(nodes[2]);
1726         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1727
1728         // flush the htlcs in the holding cell
1729         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1730         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1731         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1732         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1733         expect_pending_htlcs_forwardable!(nodes[1]);
1734
1735         let ref payment_event_3 = expect_forward!(nodes[1]);
1736         assert_eq!(payment_event_3.msgs.len(), 2);
1737         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1738         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1739
1740         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1741         expect_pending_htlcs_forwardable!(nodes[2]);
1742
1743         let events = nodes[2].node.get_and_clear_pending_events();
1744         assert_eq!(events.len(), 2);
1745         match events[0] {
1746                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1747                         assert_eq!(our_payment_hash_21, *payment_hash);
1748                         assert_eq!(*payment_secret, None);
1749                         assert_eq!(recv_value_21, amt);
1750                 },
1751                 _ => panic!("Unexpected event"),
1752         }
1753         match events[1] {
1754                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1755                         assert_eq!(our_payment_hash_22, *payment_hash);
1756                         assert_eq!(None, *payment_secret);
1757                         assert_eq!(recv_value_22, amt);
1758                 },
1759                 _ => panic!("Unexpected event"),
1760         }
1761
1762         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1763         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1764         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1765
1766         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);
1767         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1768         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1769         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1770
1771         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1772         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1773 }
1774
1775 #[test]
1776 fn channel_reserve_test() {
1777         do_channel_reserve_test(false);
1778         do_channel_reserve_test(true);
1779 }
1780
1781 #[test]
1782 fn channel_reserve_in_flight_removes() {
1783         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1784         // can send to its counterparty, but due to update ordering, the other side may not yet have
1785         // considered those HTLCs fully removed.
1786         // This tests that we don't count HTLCs which will not be included in the next remote
1787         // commitment transaction towards the reserve value (as it implies no commitment transaction
1788         // will be generated which violates the remote reserve value).
1789         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1790         // To test this we:
1791         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1792         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1793         //    you only consider the value of the first HTLC, it may not),
1794         //  * start routing a third HTLC from A to B,
1795         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1796         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1797         //  * deliver the first fulfill from B
1798         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1799         //    claim,
1800         //  * deliver A's response CS and RAA.
1801         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1802         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1803         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1804         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1805         let chanmon_cfgs = create_chanmon_cfgs(2);
1806         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1807         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1808         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1809         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1810
1811         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1812         // Route the first two HTLCs.
1813         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1814         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1815
1816         // Start routing the third HTLC (this is just used to get everyone in the right state).
1817         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1818         let send_1 = {
1819                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1820                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
1821                 check_added_monitors!(nodes[0], 1);
1822                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1823                 assert_eq!(events.len(), 1);
1824                 SendEvent::from_event(events.remove(0))
1825         };
1826
1827         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1828         // initial fulfill/CS.
1829         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1830         check_added_monitors!(nodes[1], 1);
1831         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1832
1833         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1834         // remove the second HTLC when we send the HTLC back from B to A.
1835         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
1836         check_added_monitors!(nodes[1], 1);
1837         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1838
1839         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1840         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1841         check_added_monitors!(nodes[0], 1);
1842         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1843         expect_payment_sent!(nodes[0], payment_preimage_1);
1844
1845         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1846         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1847         check_added_monitors!(nodes[1], 1);
1848         // B is already AwaitingRAA, so cant generate a CS here
1849         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1850
1851         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1852         check_added_monitors!(nodes[1], 1);
1853         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1854
1855         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1856         check_added_monitors!(nodes[0], 1);
1857         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1858
1859         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1860         check_added_monitors!(nodes[1], 1);
1861         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1862
1863         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1864         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1865         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1866         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1867         // on-chain as necessary).
1868         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1869         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1870         check_added_monitors!(nodes[0], 1);
1871         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1872         expect_payment_sent!(nodes[0], payment_preimage_2);
1873
1874         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1875         check_added_monitors!(nodes[1], 1);
1876         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1877
1878         expect_pending_htlcs_forwardable!(nodes[1]);
1879         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1880
1881         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1882         // resolve the second HTLC from A's point of view.
1883         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1884         check_added_monitors!(nodes[0], 1);
1885         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1886
1887         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1888         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1889         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1890         let send_2 = {
1891                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1892                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
1893                 check_added_monitors!(nodes[1], 1);
1894                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1895                 assert_eq!(events.len(), 1);
1896                 SendEvent::from_event(events.remove(0))
1897         };
1898
1899         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1900         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1901         check_added_monitors!(nodes[0], 1);
1902         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1903
1904         // Now just resolve all the outstanding messages/HTLCs for completeness...
1905
1906         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1907         check_added_monitors!(nodes[1], 1);
1908         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1909
1910         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1911         check_added_monitors!(nodes[1], 1);
1912
1913         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1914         check_added_monitors!(nodes[0], 1);
1915         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1916
1917         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1918         check_added_monitors!(nodes[1], 1);
1919         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1920
1921         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1922         check_added_monitors!(nodes[0], 1);
1923
1924         expect_pending_htlcs_forwardable!(nodes[0]);
1925         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1926
1927         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1928         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1929 }
1930
1931 #[test]
1932 fn channel_monitor_network_test() {
1933         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1934         // tests that ChannelMonitor is able to recover from various states.
1935         let chanmon_cfgs = create_chanmon_cfgs(5);
1936         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1937         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1938         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1939
1940         // Create some initial channels
1941         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1942         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1943         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1944         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1945
1946         // Rebalance the network a bit by relaying one payment through all the channels...
1947         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1948         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1949         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1950         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1951
1952         // Simple case with no pending HTLCs:
1953         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1954         check_added_monitors!(nodes[1], 1);
1955         {
1956                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1957                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1958                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1959                 check_added_monitors!(nodes[0], 1);
1960                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1961         }
1962         get_announce_close_broadcast_events(&nodes, 0, 1);
1963         assert_eq!(nodes[0].node.list_channels().len(), 0);
1964         assert_eq!(nodes[1].node.list_channels().len(), 1);
1965
1966         // One pending HTLC is discarded by the force-close:
1967         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1968
1969         // Simple case of one pending HTLC to HTLC-Timeout
1970         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1971         check_added_monitors!(nodes[1], 1);
1972         {
1973                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1974                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1975                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1976                 check_added_monitors!(nodes[2], 1);
1977                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1978         }
1979         get_announce_close_broadcast_events(&nodes, 1, 2);
1980         assert_eq!(nodes[1].node.list_channels().len(), 0);
1981         assert_eq!(nodes[2].node.list_channels().len(), 1);
1982
1983         macro_rules! claim_funds {
1984                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1985                         {
1986                                 assert!($node.node.claim_funds($preimage, &None, $amount));
1987                                 check_added_monitors!($node, 1);
1988
1989                                 let events = $node.node.get_and_clear_pending_msg_events();
1990                                 assert_eq!(events.len(), 1);
1991                                 match events[0] {
1992                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1993                                                 assert!(update_add_htlcs.is_empty());
1994                                                 assert!(update_fail_htlcs.is_empty());
1995                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1996                                         },
1997                                         _ => panic!("Unexpected event"),
1998                                 };
1999                         }
2000                 }
2001         }
2002
2003         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2004         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2005         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2006         check_added_monitors!(nodes[2], 1);
2007         let node2_commitment_txid;
2008         {
2009                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2010                 node2_commitment_txid = node_txn[0].txid();
2011
2012                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2013                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2014
2015                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2016                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2017                 check_added_monitors!(nodes[3], 1);
2018
2019                 check_preimage_claim(&nodes[3], &node_txn);
2020         }
2021         get_announce_close_broadcast_events(&nodes, 2, 3);
2022         assert_eq!(nodes[2].node.list_channels().len(), 0);
2023         assert_eq!(nodes[3].node.list_channels().len(), 1);
2024
2025         { // Cheat and reset nodes[4]'s height to 1
2026                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2027                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2028         }
2029
2030         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2031         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2032         // One pending HTLC to time out:
2033         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2034         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2035         // buffer space).
2036
2037         {
2038                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2039                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2040                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2041                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2042                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2043                 }
2044                 check_added_monitors!(nodes[3], 1);
2045
2046                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2047                 {
2048                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2049                         node_txn.retain(|tx| {
2050                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2051                                         false
2052                                 } else { true }
2053                         });
2054                 }
2055
2056                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2057
2058                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2059                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2060
2061                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2062
2063                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2064                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2065                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2066                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2067                 }
2068
2069                 check_added_monitors!(nodes[4], 1);
2070                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2071
2072                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2073                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2074
2075                 check_preimage_claim(&nodes[4], &node_txn);
2076         }
2077         get_announce_close_broadcast_events(&nodes, 3, 4);
2078         assert_eq!(nodes[3].node.list_channels().len(), 0);
2079         assert_eq!(nodes[4].node.list_channels().len(), 0);
2080 }
2081
2082 #[test]
2083 fn test_justice_tx() {
2084         // Test justice txn built on revoked HTLC-Success tx, against both sides
2085         let mut alice_config = UserConfig::default();
2086         alice_config.channel_options.announced_channel = true;
2087         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2088         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2089         let mut bob_config = UserConfig::default();
2090         bob_config.channel_options.announced_channel = true;
2091         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2092         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2093         let user_cfgs = [Some(alice_config), Some(bob_config)];
2094         let chanmon_cfgs = create_chanmon_cfgs(2);
2095         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2096         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2097         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2098         // Create some new channels:
2099         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2100
2101         // A pending HTLC which will be revoked:
2102         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2103         // Get the will-be-revoked local txn from nodes[0]
2104         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2105         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2106         assert_eq!(revoked_local_txn[0].input.len(), 1);
2107         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2108         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2109         assert_eq!(revoked_local_txn[1].input.len(), 1);
2110         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2111         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2112         // Revoke the old state
2113         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2114
2115         {
2116                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2117                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2118                 {
2119                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2120                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2121                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2122
2123                         check_spends!(node_txn[0], revoked_local_txn[0]);
2124                         node_txn.swap_remove(0);
2125                         node_txn.truncate(1);
2126                 }
2127                 check_added_monitors!(nodes[1], 1);
2128                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2129
2130                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2131                 // Verify broadcast of revoked HTLC-timeout
2132                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2133                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2134                 check_added_monitors!(nodes[0], 1);
2135                 // Broadcast revoked HTLC-timeout on node 1
2136                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2137                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2138         }
2139         get_announce_close_broadcast_events(&nodes, 0, 1);
2140
2141         assert_eq!(nodes[0].node.list_channels().len(), 0);
2142         assert_eq!(nodes[1].node.list_channels().len(), 0);
2143
2144         // We test justice_tx build by A on B's revoked HTLC-Success tx
2145         // Create some new channels:
2146         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2147         {
2148                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2149                 node_txn.clear();
2150         }
2151
2152         // A pending HTLC which will be revoked:
2153         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2154         // Get the will-be-revoked local txn from B
2155         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2156         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2157         assert_eq!(revoked_local_txn[0].input.len(), 1);
2158         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2159         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2160         // Revoke the old state
2161         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2162         {
2163                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2164                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2165                 {
2166                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2167                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2168                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2169
2170                         check_spends!(node_txn[0], revoked_local_txn[0]);
2171                         node_txn.swap_remove(0);
2172                 }
2173                 check_added_monitors!(nodes[0], 1);
2174                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2175
2176                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2177                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2178                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2179                 check_added_monitors!(nodes[1], 1);
2180                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2181                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2182         }
2183         get_announce_close_broadcast_events(&nodes, 0, 1);
2184         assert_eq!(nodes[0].node.list_channels().len(), 0);
2185         assert_eq!(nodes[1].node.list_channels().len(), 0);
2186 }
2187
2188 #[test]
2189 fn revoked_output_claim() {
2190         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2191         // transaction is broadcast by its counterparty
2192         let chanmon_cfgs = create_chanmon_cfgs(2);
2193         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2194         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2195         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2196         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2197         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2198         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2199         assert_eq!(revoked_local_txn.len(), 1);
2200         // Only output is the full channel value back to nodes[0]:
2201         assert_eq!(revoked_local_txn[0].output.len(), 1);
2202         // Send a payment through, updating everyone's latest commitment txn
2203         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2204
2205         // Inform nodes[1] that nodes[0] broadcast a stale tx
2206         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2207         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2208         check_added_monitors!(nodes[1], 1);
2209         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2210         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2211
2212         check_spends!(node_txn[0], revoked_local_txn[0]);
2213         check_spends!(node_txn[1], chan_1.3);
2214
2215         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2216         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2217         get_announce_close_broadcast_events(&nodes, 0, 1);
2218         check_added_monitors!(nodes[0], 1)
2219 }
2220
2221 #[test]
2222 fn claim_htlc_outputs_shared_tx() {
2223         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2224         let chanmon_cfgs = create_chanmon_cfgs(2);
2225         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2226         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2227         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2228
2229         // Create some new channel:
2230         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2231
2232         // Rebalance the network to generate htlc in the two directions
2233         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2234         // 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
2235         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2236         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2237
2238         // Get the will-be-revoked local txn from node[0]
2239         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2240         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2241         assert_eq!(revoked_local_txn[0].input.len(), 1);
2242         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2243         assert_eq!(revoked_local_txn[1].input.len(), 1);
2244         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2245         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2246         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2247
2248         //Revoke the old state
2249         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2250
2251         {
2252                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2253                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2254                 check_added_monitors!(nodes[0], 1);
2255                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2256                 check_added_monitors!(nodes[1], 1);
2257                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2258
2259                 let events = nodes[1].node.get_and_clear_pending_events();
2260                 assert_eq!(events.len(), 1);
2261                 match events[0] {
2262                         Event::PaymentFailed { payment_hash, .. } => {
2263                                 assert_eq!(payment_hash, payment_hash_2);
2264                         },
2265                         _ => panic!("Unexpected event"),
2266                 }
2267
2268                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2269                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2270
2271                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2272                 check_spends!(node_txn[0], revoked_local_txn[0]);
2273
2274                 let mut witness_lens = BTreeSet::new();
2275                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2276                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2277                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2278                 assert_eq!(witness_lens.len(), 3);
2279                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2280                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2281                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2282
2283                 // Next nodes[1] broadcasts its current local tx state:
2284                 assert_eq!(node_txn[1].input.len(), 1);
2285                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2286
2287                 assert_eq!(node_txn[2].input.len(), 1);
2288                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2289                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2290                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2291                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2292                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2293         }
2294         get_announce_close_broadcast_events(&nodes, 0, 1);
2295         assert_eq!(nodes[0].node.list_channels().len(), 0);
2296         assert_eq!(nodes[1].node.list_channels().len(), 0);
2297 }
2298
2299 #[test]
2300 fn claim_htlc_outputs_single_tx() {
2301         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2302         let chanmon_cfgs = create_chanmon_cfgs(2);
2303         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2304         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2305         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2306
2307         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2308
2309         // Rebalance the network to generate htlc in the two directions
2310         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2311         // 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
2312         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2313         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2314         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2315
2316         // Get the will-be-revoked local txn from node[0]
2317         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2318
2319         //Revoke the old state
2320         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2321
2322         {
2323                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2324                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2325                 check_added_monitors!(nodes[0], 1);
2326                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2327                 check_added_monitors!(nodes[1], 1);
2328                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2329
2330                 let events = nodes[1].node.get_and_clear_pending_events();
2331                 assert_eq!(events.len(), 1);
2332                 match events[0] {
2333                         Event::PaymentFailed { payment_hash, .. } => {
2334                                 assert_eq!(payment_hash, payment_hash_2);
2335                         },
2336                         _ => panic!("Unexpected event"),
2337                 }
2338
2339                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2340                 assert_eq!(node_txn.len(), 9);
2341                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2342                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2343                 // 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)
2344                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2345
2346                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2347                 assert_eq!(node_txn[2].input.len(), 1);
2348                 check_spends!(node_txn[2], chan_1.3);
2349                 assert_eq!(node_txn[3].input.len(), 1);
2350                 let witness_script = node_txn[3].input[0].witness.last().unwrap();
2351                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2352                 check_spends!(node_txn[3], node_txn[2]);
2353
2354                 // Justice transactions are indices 1-2-4
2355                 assert_eq!(node_txn[0].input.len(), 1);
2356                 assert_eq!(node_txn[1].input.len(), 1);
2357                 assert_eq!(node_txn[4].input.len(), 1);
2358
2359                 check_spends!(node_txn[0], revoked_local_txn[0]);
2360                 check_spends!(node_txn[1], revoked_local_txn[0]);
2361                 check_spends!(node_txn[4], revoked_local_txn[0]);
2362
2363                 let mut witness_lens = BTreeSet::new();
2364                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2365                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2366                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2367                 assert_eq!(witness_lens.len(), 3);
2368                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2369                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2370                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2371         }
2372         get_announce_close_broadcast_events(&nodes, 0, 1);
2373         assert_eq!(nodes[0].node.list_channels().len(), 0);
2374         assert_eq!(nodes[1].node.list_channels().len(), 0);
2375 }
2376
2377 #[test]
2378 fn test_htlc_on_chain_success() {
2379         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2380         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2381         // broadcasting the right event to other nodes in payment path.
2382         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2383         // A --------------------> B ----------------------> C (preimage)
2384         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2385         // commitment transaction was broadcast.
2386         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2387         // towards B.
2388         // B should be able to claim via preimage if A then broadcasts its local tx.
2389         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2390         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2391         // PaymentSent event).
2392
2393         let chanmon_cfgs = create_chanmon_cfgs(3);
2394         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2395         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2396         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2397
2398         // Create some initial channels
2399         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2400         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2401
2402         // Rebalance the network a bit by relaying one payment through all the channels...
2403         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2404         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2405
2406         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2407         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2408         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2409
2410         // Broadcast legit commitment tx from C on B's chain
2411         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2412         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2413         assert_eq!(commitment_tx.len(), 1);
2414         check_spends!(commitment_tx[0], chan_2.3);
2415         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2416         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2417         check_added_monitors!(nodes[2], 2);
2418         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2419         assert!(updates.update_add_htlcs.is_empty());
2420         assert!(updates.update_fail_htlcs.is_empty());
2421         assert!(updates.update_fail_malformed_htlcs.is_empty());
2422         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2423
2424         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2425         check_closed_broadcast!(nodes[2], false);
2426         check_added_monitors!(nodes[2], 1);
2427         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)
2428         assert_eq!(node_txn.len(), 5);
2429         assert_eq!(node_txn[0], node_txn[3]);
2430         assert_eq!(node_txn[1], node_txn[4]);
2431         assert_eq!(node_txn[2], commitment_tx[0]);
2432         check_spends!(node_txn[0], commitment_tx[0]);
2433         check_spends!(node_txn[1], commitment_tx[0]);
2434         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2435         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2436         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2437         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2438         assert_eq!(node_txn[0].lock_time, 0);
2439         assert_eq!(node_txn[1].lock_time, 0);
2440
2441         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2442         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2443         {
2444                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2445                 assert_eq!(added_monitors.len(), 1);
2446                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2447                 added_monitors.clear();
2448         }
2449         let events = nodes[1].node.get_and_clear_pending_msg_events();
2450         {
2451                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2452                 assert_eq!(added_monitors.len(), 2);
2453                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2454                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2455                 added_monitors.clear();
2456         }
2457         assert_eq!(events.len(), 2);
2458         match events[0] {
2459                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2460                 _ => panic!("Unexpected event"),
2461         }
2462         match events[1] {
2463                 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, .. } } => {
2464                         assert!(update_add_htlcs.is_empty());
2465                         assert!(update_fail_htlcs.is_empty());
2466                         assert_eq!(update_fulfill_htlcs.len(), 1);
2467                         assert!(update_fail_malformed_htlcs.is_empty());
2468                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2469                 },
2470                 _ => panic!("Unexpected event"),
2471         };
2472         macro_rules! check_tx_local_broadcast {
2473                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2474                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2475                         assert_eq!(node_txn.len(), 5);
2476                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2477                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2478                         check_spends!(node_txn[0], $commitment_tx);
2479                         check_spends!(node_txn[1], $commitment_tx);
2480                         assert_ne!(node_txn[0].lock_time, 0);
2481                         assert_ne!(node_txn[1].lock_time, 0);
2482                         if $htlc_offered {
2483                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2484                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2485                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2486                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2487                         } else {
2488                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2489                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2490                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2491                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2492                         }
2493                         check_spends!(node_txn[2], $chan_tx);
2494                         check_spends!(node_txn[3], node_txn[2]);
2495                         check_spends!(node_txn[4], node_txn[2]);
2496                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2497                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2498                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2499                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2500                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2501                         assert_ne!(node_txn[3].lock_time, 0);
2502                         assert_ne!(node_txn[4].lock_time, 0);
2503                         node_txn.clear();
2504                 } }
2505         }
2506         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2507         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2508         // timeout-claim of the output that nodes[2] just claimed via success.
2509         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2510
2511         // Broadcast legit commitment tx from A on B's chain
2512         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2513         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2514         check_spends!(commitment_tx[0], chan_1.3);
2515         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2516         check_closed_broadcast!(nodes[1], false);
2517         check_added_monitors!(nodes[1], 1);
2518         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2519         assert_eq!(node_txn.len(), 4);
2520         check_spends!(node_txn[0], commitment_tx[0]);
2521         assert_eq!(node_txn[0].input.len(), 2);
2522         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2523         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2524         assert_eq!(node_txn[0].lock_time, 0);
2525         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2526         check_spends!(node_txn[1], chan_1.3);
2527         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2528         check_spends!(node_txn[2], node_txn[1]);
2529         check_spends!(node_txn[3], node_txn[1]);
2530         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2531         // we already checked the same situation with A.
2532
2533         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2534         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2535         check_closed_broadcast!(nodes[0], false);
2536         check_added_monitors!(nodes[0], 1);
2537         let events = nodes[0].node.get_and_clear_pending_events();
2538         assert_eq!(events.len(), 2);
2539         let mut first_claimed = false;
2540         for event in events {
2541                 match event {
2542                         Event::PaymentSent { payment_preimage } => {
2543                                 if payment_preimage == our_payment_preimage {
2544                                         assert!(!first_claimed);
2545                                         first_claimed = true;
2546                                 } else {
2547                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2548                                 }
2549                         },
2550                         _ => panic!("Unexpected event"),
2551                 }
2552         }
2553         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2554 }
2555
2556 #[test]
2557 fn test_htlc_on_chain_timeout() {
2558         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2559         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2560         // broadcasting the right event to other nodes in payment path.
2561         // A ------------------> B ----------------------> C (timeout)
2562         //    B's commitment tx                 C's commitment tx
2563         //            \                                  \
2564         //         B's HTLC timeout tx               B's timeout tx
2565
2566         let chanmon_cfgs = create_chanmon_cfgs(3);
2567         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2568         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2569         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2570
2571         // Create some intial channels
2572         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2573         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2574
2575         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2576         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2577         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2578
2579         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2580         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2581
2582         // Broadcast legit commitment tx from C on B's chain
2583         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2584         check_spends!(commitment_tx[0], chan_2.3);
2585         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2586         check_added_monitors!(nodes[2], 0);
2587         expect_pending_htlcs_forwardable!(nodes[2]);
2588         check_added_monitors!(nodes[2], 1);
2589
2590         let events = nodes[2].node.get_and_clear_pending_msg_events();
2591         assert_eq!(events.len(), 1);
2592         match events[0] {
2593                 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, .. } } => {
2594                         assert!(update_add_htlcs.is_empty());
2595                         assert!(!update_fail_htlcs.is_empty());
2596                         assert!(update_fulfill_htlcs.is_empty());
2597                         assert!(update_fail_malformed_htlcs.is_empty());
2598                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2599                 },
2600                 _ => panic!("Unexpected event"),
2601         };
2602         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2603         check_closed_broadcast!(nodes[2], false);
2604         check_added_monitors!(nodes[2], 1);
2605         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2606         assert_eq!(node_txn.len(), 1);
2607         check_spends!(node_txn[0], chan_2.3);
2608         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2609
2610         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2611         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2612         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2613         let timeout_tx;
2614         {
2615                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2616                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2617                 assert_eq!(node_txn[1], node_txn[3]);
2618                 assert_eq!(node_txn[2], node_txn[4]);
2619
2620                 check_spends!(node_txn[0], commitment_tx[0]);
2621                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2622
2623                 check_spends!(node_txn[1], chan_2.3);
2624                 check_spends!(node_txn[2], node_txn[1]);
2625                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2626                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2627
2628                 timeout_tx = node_txn[0].clone();
2629                 node_txn.clear();
2630         }
2631
2632         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2633         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2634         check_added_monitors!(nodes[1], 1);
2635         check_closed_broadcast!(nodes[1], false);
2636
2637         expect_pending_htlcs_forwardable!(nodes[1]);
2638         check_added_monitors!(nodes[1], 1);
2639         let events = nodes[1].node.get_and_clear_pending_msg_events();
2640         assert_eq!(events.len(), 1);
2641         match events[0] {
2642                 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, .. } } => {
2643                         assert!(update_add_htlcs.is_empty());
2644                         assert!(!update_fail_htlcs.is_empty());
2645                         assert!(update_fulfill_htlcs.is_empty());
2646                         assert!(update_fail_malformed_htlcs.is_empty());
2647                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2648                 },
2649                 _ => panic!("Unexpected event"),
2650         };
2651         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
2652         assert_eq!(node_txn.len(), 0);
2653
2654         // Broadcast legit commitment tx from B on A's chain
2655         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2656         check_spends!(commitment_tx[0], chan_1.3);
2657
2658         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2659         check_closed_broadcast!(nodes[0], false);
2660         check_added_monitors!(nodes[0], 1);
2661         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2662         assert_eq!(node_txn.len(), 3);
2663         check_spends!(node_txn[0], commitment_tx[0]);
2664         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2665         check_spends!(node_txn[1], chan_1.3);
2666         check_spends!(node_txn[2], node_txn[1]);
2667         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2668         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2669 }
2670
2671 #[test]
2672 fn test_simple_commitment_revoked_fail_backward() {
2673         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2674         // and fail backward accordingly.
2675
2676         let chanmon_cfgs = create_chanmon_cfgs(3);
2677         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2678         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2679         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2680
2681         // Create some initial channels
2682         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2683         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2684
2685         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2686         // Get the will-be-revoked local txn from nodes[2]
2687         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2688         // Revoke the old state
2689         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2690
2691         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2692
2693         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2694         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2695         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2696         check_added_monitors!(nodes[1], 1);
2697         check_closed_broadcast!(nodes[1], false);
2698
2699         expect_pending_htlcs_forwardable!(nodes[1]);
2700         check_added_monitors!(nodes[1], 1);
2701         let events = nodes[1].node.get_and_clear_pending_msg_events();
2702         assert_eq!(events.len(), 1);
2703         match events[0] {
2704                 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, .. } } => {
2705                         assert!(update_add_htlcs.is_empty());
2706                         assert_eq!(update_fail_htlcs.len(), 1);
2707                         assert!(update_fulfill_htlcs.is_empty());
2708                         assert!(update_fail_malformed_htlcs.is_empty());
2709                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2710
2711                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2712                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2713
2714                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2715                         assert_eq!(events.len(), 1);
2716                         match events[0] {
2717                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2718                                 _ => panic!("Unexpected event"),
2719                         }
2720                         let events = nodes[0].node.get_and_clear_pending_events();
2721                         assert_eq!(events.len(), 1);
2722                         match events[0] {
2723                                 Event::PaymentFailed { .. } => {},
2724                                 _ => panic!("Unexpected event"),
2725                         }
2726                 },
2727                 _ => panic!("Unexpected event"),
2728         }
2729 }
2730
2731 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2732         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2733         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2734         // commitment transaction anymore.
2735         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2736         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2737         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2738         // technically disallowed and we should probably handle it reasonably.
2739         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2740         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2741         // transactions:
2742         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2743         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2744         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2745         //   and once they revoke the previous commitment transaction (allowing us to send a new
2746         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2747         let chanmon_cfgs = create_chanmon_cfgs(3);
2748         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2749         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2750         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2751
2752         // Create some initial channels
2753         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2754         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2755
2756         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2757         // Get the will-be-revoked local txn from nodes[2]
2758         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2759         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2760         // Revoke the old state
2761         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2762
2763         let value = if use_dust {
2764                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2765                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2766                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2767         } else { 3000000 };
2768
2769         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2770         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2771         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2772
2773         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
2774         expect_pending_htlcs_forwardable!(nodes[2]);
2775         check_added_monitors!(nodes[2], 1);
2776         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2777         assert!(updates.update_add_htlcs.is_empty());
2778         assert!(updates.update_fulfill_htlcs.is_empty());
2779         assert!(updates.update_fail_malformed_htlcs.is_empty());
2780         assert_eq!(updates.update_fail_htlcs.len(), 1);
2781         assert!(updates.update_fee.is_none());
2782         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2783         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2784         // Drop the last RAA from 3 -> 2
2785
2786         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
2787         expect_pending_htlcs_forwardable!(nodes[2]);
2788         check_added_monitors!(nodes[2], 1);
2789         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2790         assert!(updates.update_add_htlcs.is_empty());
2791         assert!(updates.update_fulfill_htlcs.is_empty());
2792         assert!(updates.update_fail_malformed_htlcs.is_empty());
2793         assert_eq!(updates.update_fail_htlcs.len(), 1);
2794         assert!(updates.update_fee.is_none());
2795         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2796         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2797         check_added_monitors!(nodes[1], 1);
2798         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2799         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2800         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2801         check_added_monitors!(nodes[2], 1);
2802
2803         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
2804         expect_pending_htlcs_forwardable!(nodes[2]);
2805         check_added_monitors!(nodes[2], 1);
2806         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2807         assert!(updates.update_add_htlcs.is_empty());
2808         assert!(updates.update_fulfill_htlcs.is_empty());
2809         assert!(updates.update_fail_malformed_htlcs.is_empty());
2810         assert_eq!(updates.update_fail_htlcs.len(), 1);
2811         assert!(updates.update_fee.is_none());
2812         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2813         // At this point first_payment_hash has dropped out of the latest two commitment
2814         // transactions that nodes[1] is tracking...
2815         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2816         check_added_monitors!(nodes[1], 1);
2817         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2818         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2819         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2820         check_added_monitors!(nodes[2], 1);
2821
2822         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2823         // on nodes[2]'s RAA.
2824         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2825         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2826         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
2827         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2828         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2829         check_added_monitors!(nodes[1], 0);
2830
2831         if deliver_bs_raa {
2832                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2833                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2834                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2835                 check_added_monitors!(nodes[1], 1);
2836                 let events = nodes[1].node.get_and_clear_pending_events();
2837                 assert_eq!(events.len(), 1);
2838                 match events[0] {
2839                         Event::PendingHTLCsForwardable { .. } => { },
2840                         _ => panic!("Unexpected event"),
2841                 };
2842                 // Deliberately don't process the pending fail-back so they all fail back at once after
2843                 // block connection just like the !deliver_bs_raa case
2844         }
2845
2846         let mut failed_htlcs = HashSet::new();
2847         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2848
2849         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2850         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2851         check_added_monitors!(nodes[1], 1);
2852         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2853
2854         let events = nodes[1].node.get_and_clear_pending_events();
2855         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2856         match events[0] {
2857                 Event::PaymentFailed { ref payment_hash, .. } => {
2858                         assert_eq!(*payment_hash, fourth_payment_hash);
2859                 },
2860                 _ => panic!("Unexpected event"),
2861         }
2862         if !deliver_bs_raa {
2863                 match events[1] {
2864                         Event::PendingHTLCsForwardable { .. } => { },
2865                         _ => panic!("Unexpected event"),
2866                 };
2867         }
2868         nodes[1].node.process_pending_htlc_forwards();
2869         check_added_monitors!(nodes[1], 1);
2870
2871         let events = nodes[1].node.get_and_clear_pending_msg_events();
2872         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2873         match events[if deliver_bs_raa { 1 } else { 0 }] {
2874                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2875                 _ => panic!("Unexpected event"),
2876         }
2877         if deliver_bs_raa {
2878                 match events[0] {
2879                         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, .. } } => {
2880                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2881                                 assert_eq!(update_add_htlcs.len(), 1);
2882                                 assert!(update_fulfill_htlcs.is_empty());
2883                                 assert!(update_fail_htlcs.is_empty());
2884                                 assert!(update_fail_malformed_htlcs.is_empty());
2885                         },
2886                         _ => panic!("Unexpected event"),
2887                 }
2888         }
2889         match events[if deliver_bs_raa { 2 } else { 1 }] {
2890                 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, .. } } => {
2891                         assert!(update_add_htlcs.is_empty());
2892                         assert_eq!(update_fail_htlcs.len(), 3);
2893                         assert!(update_fulfill_htlcs.is_empty());
2894                         assert!(update_fail_malformed_htlcs.is_empty());
2895                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2896
2897                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2898                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2899                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2900
2901                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2902
2903                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2904                         // If we delivered B's RAA we got an unknown preimage error, not something
2905                         // that we should update our routing table for.
2906                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2907                         for event in events {
2908                                 match event {
2909                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2910                                         _ => panic!("Unexpected event"),
2911                                 }
2912                         }
2913                         let events = nodes[0].node.get_and_clear_pending_events();
2914                         assert_eq!(events.len(), 3);
2915                         match events[0] {
2916                                 Event::PaymentFailed { ref payment_hash, .. } => {
2917                                         assert!(failed_htlcs.insert(payment_hash.0));
2918                                 },
2919                                 _ => panic!("Unexpected event"),
2920                         }
2921                         match events[1] {
2922                                 Event::PaymentFailed { ref payment_hash, .. } => {
2923                                         assert!(failed_htlcs.insert(payment_hash.0));
2924                                 },
2925                                 _ => panic!("Unexpected event"),
2926                         }
2927                         match events[2] {
2928                                 Event::PaymentFailed { ref payment_hash, .. } => {
2929                                         assert!(failed_htlcs.insert(payment_hash.0));
2930                                 },
2931                                 _ => panic!("Unexpected event"),
2932                         }
2933                 },
2934                 _ => panic!("Unexpected event"),
2935         }
2936
2937         assert!(failed_htlcs.contains(&first_payment_hash.0));
2938         assert!(failed_htlcs.contains(&second_payment_hash.0));
2939         assert!(failed_htlcs.contains(&third_payment_hash.0));
2940 }
2941
2942 #[test]
2943 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2944         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2945         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2946         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2947         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2948 }
2949
2950 #[test]
2951 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2952         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2953         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2954         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2955         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2956 }
2957
2958 #[test]
2959 fn fail_backward_pending_htlc_upon_channel_failure() {
2960         let chanmon_cfgs = create_chanmon_cfgs(2);
2961         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2962         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2963         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2964         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::supported(), InitFeatures::supported());
2965
2966         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
2967         {
2968                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
2969                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2970                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
2971                 check_added_monitors!(nodes[0], 1);
2972
2973                 let payment_event = {
2974                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2975                         assert_eq!(events.len(), 1);
2976                         SendEvent::from_event(events.remove(0))
2977                 };
2978                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
2979                 assert_eq!(payment_event.msgs.len(), 1);
2980         }
2981
2982         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
2983         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2984         {
2985                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2986                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
2987                 check_added_monitors!(nodes[0], 0);
2988
2989                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2990         }
2991
2992         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
2993         {
2994                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2995                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
2996
2997                 let secp_ctx = Secp256k1::new();
2998                 let session_priv = {
2999                         let mut session_key = [0; 32];
3000                         let mut rng = thread_rng();
3001                         rng.fill_bytes(&mut session_key);
3002                         SecretKey::from_slice(&session_key).expect("RNG is bad!")
3003                 };
3004
3005                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3006                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3007                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3008                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3009
3010                 // Send a 0-msat update_add_htlc to fail the channel.
3011                 let update_add_htlc = msgs::UpdateAddHTLC {
3012                         channel_id: chan.2,
3013                         htlc_id: 0,
3014                         amount_msat: 0,
3015                         payment_hash,
3016                         cltv_expiry,
3017                         onion_routing_packet,
3018                 };
3019                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3020         }
3021
3022         // Check that Alice fails backward the pending HTLC from the second payment.
3023         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3024         check_closed_broadcast!(nodes[0], true);
3025         check_added_monitors!(nodes[0], 1);
3026 }
3027
3028 #[test]
3029 fn test_htlc_ignore_latest_remote_commitment() {
3030         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3031         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3032         let chanmon_cfgs = create_chanmon_cfgs(2);
3033         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3034         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3035         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3036         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3037
3038         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3039         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3040         check_closed_broadcast!(nodes[0], false);
3041         check_added_monitors!(nodes[0], 1);
3042
3043         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3044         assert_eq!(node_txn.len(), 2);
3045
3046         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3047         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3048         check_closed_broadcast!(nodes[1], false);
3049         check_added_monitors!(nodes[1], 1);
3050
3051         // Duplicate the block_connected call since this may happen due to other listeners
3052         // registering new transactions
3053         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3054 }
3055
3056 #[test]
3057 fn test_force_close_fail_back() {
3058         // Check which HTLCs are failed-backwards on channel force-closure
3059         let chanmon_cfgs = create_chanmon_cfgs(3);
3060         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3061         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3062         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3063         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3064         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3065
3066         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
3067
3068         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3069
3070         let mut payment_event = {
3071                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3072                 check_added_monitors!(nodes[0], 1);
3073
3074                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3075                 assert_eq!(events.len(), 1);
3076                 SendEvent::from_event(events.remove(0))
3077         };
3078
3079         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3080         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3081
3082         expect_pending_htlcs_forwardable!(nodes[1]);
3083
3084         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3085         assert_eq!(events_2.len(), 1);
3086         payment_event = SendEvent::from_event(events_2.remove(0));
3087         assert_eq!(payment_event.msgs.len(), 1);
3088
3089         check_added_monitors!(nodes[1], 1);
3090         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3091         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3092         check_added_monitors!(nodes[2], 1);
3093         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3094
3095         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3096         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3097         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3098
3099         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3100         check_closed_broadcast!(nodes[2], false);
3101         check_added_monitors!(nodes[2], 1);
3102         let tx = {
3103                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3104                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3105                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3106                 // back to nodes[1] upon timeout otherwise.
3107                 assert_eq!(node_txn.len(), 1);
3108                 node_txn.remove(0)
3109         };
3110
3111         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3112         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3113
3114         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3115         check_closed_broadcast!(nodes[1], false);
3116         check_added_monitors!(nodes[1], 1);
3117
3118         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3119         {
3120                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3121                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
3122                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3123         }
3124         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3125         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3126         assert_eq!(node_txn.len(), 1);
3127         assert_eq!(node_txn[0].input.len(), 1);
3128         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3129         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3130         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3131
3132         check_spends!(node_txn[0], tx);
3133 }
3134
3135 #[test]
3136 fn test_unconf_chan() {
3137         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3138         let chanmon_cfgs = create_chanmon_cfgs(2);
3139         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3140         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3141         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3142         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3143
3144         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3145         assert_eq!(channel_state.by_id.len(), 1);
3146         assert_eq!(channel_state.short_to_id.len(), 1);
3147         mem::drop(channel_state);
3148
3149         let mut headers = Vec::new();
3150         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3151         headers.push(header.clone());
3152         for _i in 2..100 {
3153                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3154                 headers.push(header.clone());
3155         }
3156         let mut height = 99;
3157         while !headers.is_empty() {
3158                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3159                 height -= 1;
3160         }
3161         check_closed_broadcast!(nodes[0], false);
3162         check_added_monitors!(nodes[0], 1);
3163         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3164         assert_eq!(channel_state.by_id.len(), 0);
3165         assert_eq!(channel_state.short_to_id.len(), 0);
3166 }
3167
3168 #[test]
3169 fn test_simple_peer_disconnect() {
3170         // Test that we can reconnect when there are no lost messages
3171         let chanmon_cfgs = create_chanmon_cfgs(3);
3172         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3173         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3174         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3175         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3176         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3177
3178         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3179         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3180         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3181
3182         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3183         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3184         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3185         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3186
3187         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3188         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3189         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3190
3191         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3192         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3193         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3194         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3195
3196         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3197         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3198
3199         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3200         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3201
3202         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3203         {
3204                 let events = nodes[0].node.get_and_clear_pending_events();
3205                 assert_eq!(events.len(), 2);
3206                 match events[0] {
3207                         Event::PaymentSent { payment_preimage } => {
3208                                 assert_eq!(payment_preimage, payment_preimage_3);
3209                         },
3210                         _ => panic!("Unexpected event"),
3211                 }
3212                 match events[1] {
3213                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3214                                 assert_eq!(payment_hash, payment_hash_5);
3215                                 assert!(rejected_by_dest);
3216                         },
3217                         _ => panic!("Unexpected event"),
3218                 }
3219         }
3220
3221         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3222         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3223 }
3224
3225 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3226         // Test that we can reconnect when in-flight HTLC updates get dropped
3227         let chanmon_cfgs = create_chanmon_cfgs(2);
3228         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3229         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3230         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3231         if messages_delivered == 0 {
3232                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3233                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3234         } else {
3235                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3236         }
3237
3238         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();
3239         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3240
3241         let payment_event = {
3242                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3243                 check_added_monitors!(nodes[0], 1);
3244
3245                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3246                 assert_eq!(events.len(), 1);
3247                 SendEvent::from_event(events.remove(0))
3248         };
3249         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3250
3251         if messages_delivered < 2 {
3252                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3253         } else {
3254                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3255                 if messages_delivered >= 3 {
3256                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3257                         check_added_monitors!(nodes[1], 1);
3258                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3259
3260                         if messages_delivered >= 4 {
3261                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3262                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3263                                 check_added_monitors!(nodes[0], 1);
3264
3265                                 if messages_delivered >= 5 {
3266                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3267                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3268                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3269                                         check_added_monitors!(nodes[0], 1);
3270
3271                                         if messages_delivered >= 6 {
3272                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3273                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3274                                                 check_added_monitors!(nodes[1], 1);
3275                                         }
3276                                 }
3277                         }
3278                 }
3279         }
3280
3281         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3282         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3283         if messages_delivered < 3 {
3284                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3285                 // received on either side, both sides will need to resend them.
3286                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3287         } else if messages_delivered == 3 {
3288                 // nodes[0] still wants its RAA + commitment_signed
3289                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3290         } else if messages_delivered == 4 {
3291                 // nodes[0] still wants its commitment_signed
3292                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3293         } else if messages_delivered == 5 {
3294                 // nodes[1] still wants its final RAA
3295                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3296         } else if messages_delivered == 6 {
3297                 // Everything was delivered...
3298                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3299         }
3300
3301         let events_1 = nodes[1].node.get_and_clear_pending_events();
3302         assert_eq!(events_1.len(), 1);
3303         match events_1[0] {
3304                 Event::PendingHTLCsForwardable { .. } => { },
3305                 _ => panic!("Unexpected event"),
3306         };
3307
3308         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3309         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3310         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3311
3312         nodes[1].node.process_pending_htlc_forwards();
3313
3314         let events_2 = nodes[1].node.get_and_clear_pending_events();
3315         assert_eq!(events_2.len(), 1);
3316         match events_2[0] {
3317                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3318                         assert_eq!(payment_hash_1, *payment_hash);
3319                         assert_eq!(*payment_secret, None);
3320                         assert_eq!(amt, 1000000);
3321                 },
3322                 _ => panic!("Unexpected event"),
3323         }
3324
3325         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3326         check_added_monitors!(nodes[1], 1);
3327
3328         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3329         assert_eq!(events_3.len(), 1);
3330         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3331                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3332                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3333                         assert!(updates.update_add_htlcs.is_empty());
3334                         assert!(updates.update_fail_htlcs.is_empty());
3335                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3336                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3337                         assert!(updates.update_fee.is_none());
3338                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3339                 },
3340                 _ => panic!("Unexpected event"),
3341         };
3342
3343         if messages_delivered >= 1 {
3344                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3345
3346                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3347                 assert_eq!(events_4.len(), 1);
3348                 match events_4[0] {
3349                         Event::PaymentSent { ref payment_preimage } => {
3350                                 assert_eq!(payment_preimage_1, *payment_preimage);
3351                         },
3352                         _ => panic!("Unexpected event"),
3353                 }
3354
3355                 if messages_delivered >= 2 {
3356                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3357                         check_added_monitors!(nodes[0], 1);
3358                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3359
3360                         if messages_delivered >= 3 {
3361                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3362                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3363                                 check_added_monitors!(nodes[1], 1);
3364
3365                                 if messages_delivered >= 4 {
3366                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3367                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3368                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3369                                         check_added_monitors!(nodes[1], 1);
3370
3371                                         if messages_delivered >= 5 {
3372                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3373                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3374                                                 check_added_monitors!(nodes[0], 1);
3375                                         }
3376                                 }
3377                         }
3378                 }
3379         }
3380
3381         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3382         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3383         if messages_delivered < 2 {
3384                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3385                 //TODO: Deduplicate PaymentSent events, then enable this if:
3386                 //if messages_delivered < 1 {
3387                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3388                         assert_eq!(events_4.len(), 1);
3389                         match events_4[0] {
3390                                 Event::PaymentSent { ref payment_preimage } => {
3391                                         assert_eq!(payment_preimage_1, *payment_preimage);
3392                                 },
3393                                 _ => panic!("Unexpected event"),
3394                         }
3395                 //}
3396         } else if messages_delivered == 2 {
3397                 // nodes[0] still wants its RAA + commitment_signed
3398                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3399         } else if messages_delivered == 3 {
3400                 // nodes[0] still wants its commitment_signed
3401                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3402         } else if messages_delivered == 4 {
3403                 // nodes[1] still wants its final RAA
3404                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3405         } else if messages_delivered == 5 {
3406                 // Everything was delivered...
3407                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3408         }
3409
3410         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3411         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3412         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3413
3414         // Channel should still work fine...
3415         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3416         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3417 }
3418
3419 #[test]
3420 fn test_drop_messages_peer_disconnect_a() {
3421         do_test_drop_messages_peer_disconnect(0);
3422         do_test_drop_messages_peer_disconnect(1);
3423         do_test_drop_messages_peer_disconnect(2);
3424         do_test_drop_messages_peer_disconnect(3);
3425 }
3426
3427 #[test]
3428 fn test_drop_messages_peer_disconnect_b() {
3429         do_test_drop_messages_peer_disconnect(4);
3430         do_test_drop_messages_peer_disconnect(5);
3431         do_test_drop_messages_peer_disconnect(6);
3432 }
3433
3434 #[test]
3435 fn test_funding_peer_disconnect() {
3436         // Test that we can lock in our funding tx while disconnected
3437         let chanmon_cfgs = create_chanmon_cfgs(2);
3438         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3439         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3440         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3441         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3442
3443         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3444         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3445
3446         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3447         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3448         assert_eq!(events_1.len(), 1);
3449         match events_1[0] {
3450                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3451                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3452                 },
3453                 _ => panic!("Unexpected event"),
3454         }
3455
3456         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3457
3458         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3459         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3460
3461         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3462         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3463         assert_eq!(events_2.len(), 2);
3464         let funding_locked = match events_2[0] {
3465                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3466                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3467                         msg.clone()
3468                 },
3469                 _ => panic!("Unexpected event"),
3470         };
3471         let bs_announcement_sigs = match events_2[1] {
3472                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3473                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3474                         msg.clone()
3475                 },
3476                 _ => panic!("Unexpected event"),
3477         };
3478
3479         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3480
3481         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3482         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3483         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3484         assert_eq!(events_3.len(), 2);
3485         let as_announcement_sigs = match events_3[0] {
3486                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3487                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3488                         msg.clone()
3489                 },
3490                 _ => panic!("Unexpected event"),
3491         };
3492         let (as_announcement, as_update) = match events_3[1] {
3493                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3494                         (msg.clone(), update_msg.clone())
3495                 },
3496                 _ => panic!("Unexpected event"),
3497         };
3498
3499         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3500         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3501         assert_eq!(events_4.len(), 1);
3502         let (_, bs_update) = match events_4[0] {
3503                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3504                         (msg.clone(), update_msg.clone())
3505                 },
3506                 _ => panic!("Unexpected event"),
3507         };
3508
3509         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3510         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3511         nodes[0].router.handle_channel_update(&as_update).unwrap();
3512
3513         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3514         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3515         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3516 }
3517
3518 #[test]
3519 fn test_drop_messages_peer_disconnect_dual_htlc() {
3520         // Test that we can handle reconnecting when both sides of a channel have pending
3521         // commitment_updates when we disconnect.
3522         let chanmon_cfgs = create_chanmon_cfgs(2);
3523         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3524         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3525         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3526         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3527
3528         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3529
3530         // Now try to send a second payment which will fail to send
3531         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3532         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3533
3534         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3535         check_added_monitors!(nodes[0], 1);
3536
3537         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3538         assert_eq!(events_1.len(), 1);
3539         match events_1[0] {
3540                 MessageSendEvent::UpdateHTLCs { .. } => {},
3541                 _ => panic!("Unexpected event"),
3542         }
3543
3544         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3545         check_added_monitors!(nodes[1], 1);
3546
3547         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3548         assert_eq!(events_2.len(), 1);
3549         match events_2[0] {
3550                 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 } } => {
3551                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3552                         assert!(update_add_htlcs.is_empty());
3553                         assert_eq!(update_fulfill_htlcs.len(), 1);
3554                         assert!(update_fail_htlcs.is_empty());
3555                         assert!(update_fail_malformed_htlcs.is_empty());
3556                         assert!(update_fee.is_none());
3557
3558                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3559                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3560                         assert_eq!(events_3.len(), 1);
3561                         match events_3[0] {
3562                                 Event::PaymentSent { ref payment_preimage } => {
3563                                         assert_eq!(*payment_preimage, payment_preimage_1);
3564                                 },
3565                                 _ => panic!("Unexpected event"),
3566                         }
3567
3568                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3569                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3570                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3571                         check_added_monitors!(nodes[0], 1);
3572                 },
3573                 _ => panic!("Unexpected event"),
3574         }
3575
3576         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3577         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3578
3579         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3580         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3581         assert_eq!(reestablish_1.len(), 1);
3582         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3583         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3584         assert_eq!(reestablish_2.len(), 1);
3585
3586         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3587         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3588         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3589         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3590
3591         assert!(as_resp.0.is_none());
3592         assert!(bs_resp.0.is_none());
3593
3594         assert!(bs_resp.1.is_none());
3595         assert!(bs_resp.2.is_none());
3596
3597         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3598
3599         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3600         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3601         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3602         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3603         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3604         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3605         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3606         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3607         // No commitment_signed so get_event_msg's assert(len == 1) passes
3608         check_added_monitors!(nodes[1], 1);
3609
3610         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3611         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3612         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3613         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3614         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3615         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3616         assert!(bs_second_commitment_signed.update_fee.is_none());
3617         check_added_monitors!(nodes[1], 1);
3618
3619         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3620         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3621         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3622         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3623         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3624         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3625         assert!(as_commitment_signed.update_fee.is_none());
3626         check_added_monitors!(nodes[0], 1);
3627
3628         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3629         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3630         // No commitment_signed so get_event_msg's assert(len == 1) passes
3631         check_added_monitors!(nodes[0], 1);
3632
3633         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3634         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3635         // No commitment_signed so get_event_msg's assert(len == 1) passes
3636         check_added_monitors!(nodes[1], 1);
3637
3638         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3639         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3640         check_added_monitors!(nodes[1], 1);
3641
3642         expect_pending_htlcs_forwardable!(nodes[1]);
3643
3644         let events_5 = nodes[1].node.get_and_clear_pending_events();
3645         assert_eq!(events_5.len(), 1);
3646         match events_5[0] {
3647                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3648                         assert_eq!(payment_hash_2, *payment_hash);
3649                         assert_eq!(*payment_secret, None);
3650                 },
3651                 _ => panic!("Unexpected event"),
3652         }
3653
3654         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3655         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3656         check_added_monitors!(nodes[0], 1);
3657
3658         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3659 }
3660
3661 #[test]
3662 fn test_invalid_channel_announcement() {
3663         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3664         let secp_ctx = Secp256k1::new();
3665         let chanmon_cfgs = create_chanmon_cfgs(2);
3666         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3667         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3668         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3669
3670         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3671
3672         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3673         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3674         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3675         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3676
3677         nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3678
3679         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3680         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3681
3682         let as_network_key = nodes[0].node.get_our_node_id();
3683         let bs_network_key = nodes[1].node.get_our_node_id();
3684
3685         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3686
3687         let mut chan_announcement;
3688
3689         macro_rules! dummy_unsigned_msg {
3690                 () => {
3691                         msgs::UnsignedChannelAnnouncement {
3692                                 features: ChannelFeatures::supported(),
3693                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3694                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3695                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3696                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3697                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3698                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3699                                 excess_data: Vec::new(),
3700                         };
3701                 }
3702         }
3703
3704         macro_rules! sign_msg {
3705                 ($unsigned_msg: expr) => {
3706                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3707                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key());
3708                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key());
3709                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3710                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3711                         chan_announcement = msgs::ChannelAnnouncement {
3712                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3713                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3714                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3715                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3716                                 contents: $unsigned_msg
3717                         }
3718                 }
3719         }
3720
3721         let unsigned_msg = dummy_unsigned_msg!();
3722         sign_msg!(unsigned_msg);
3723         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3724         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 } );
3725
3726         // Configured with Network::Testnet
3727         let mut unsigned_msg = dummy_unsigned_msg!();
3728         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3729         sign_msg!(unsigned_msg);
3730         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3731
3732         let mut unsigned_msg = dummy_unsigned_msg!();
3733         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3734         sign_msg!(unsigned_msg);
3735         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3736 }
3737
3738 #[test]
3739 fn test_no_txn_manager_serialize_deserialize() {
3740         let chanmon_cfgs = create_chanmon_cfgs(2);
3741         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3742         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3743         let fee_estimator: test_utils::TestFeeEstimator;
3744         let new_chan_monitor: test_utils::TestChannelMonitor;
3745         let keys_manager: test_utils::TestKeysInterface;
3746         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3747         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3748
3749         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3750
3751         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3752
3753         let nodes_0_serialized = nodes[0].node.encode();
3754         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3755         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3756
3757         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3758         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);
3759         nodes[0].chan_monitor = &new_chan_monitor;
3760         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3761         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3762         assert!(chan_0_monitor_read.is_empty());
3763
3764         let mut nodes_0_read = &nodes_0_serialized[..];
3765         let config = UserConfig::default();
3766         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3767         let (_, nodes_0_deserialized_tmp) = {
3768                 let mut channel_monitors = HashMap::new();
3769                 channel_monitors.insert(chan_0_monitor.get_funding_txo(), &mut chan_0_monitor);
3770                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3771                         default_config: config,
3772                         keys_manager: &keys_manager,
3773                         fee_estimator: &fee_estimator,
3774                         monitor: nodes[0].chan_monitor,
3775                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3776                         logger: Arc::new(test_utils::TestLogger::new()),
3777                         channel_monitors: &mut channel_monitors,
3778                 }).unwrap()
3779         };
3780         nodes_0_deserialized = nodes_0_deserialized_tmp;
3781         assert!(nodes_0_read.is_empty());
3782
3783         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo(), chan_0_monitor).is_ok());
3784         nodes[0].node = &nodes_0_deserialized;
3785         nodes[0].block_notifier.register_listener(nodes[0].node);
3786         assert_eq!(nodes[0].node.list_channels().len(), 1);
3787         check_added_monitors!(nodes[0], 1);
3788
3789         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3790         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3791         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3792         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3793
3794         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3795         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3796         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3797         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3798
3799         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3800         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3801         for node in nodes.iter() {
3802                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3803                 node.router.handle_channel_update(&as_update).unwrap();
3804                 node.router.handle_channel_update(&bs_update).unwrap();
3805         }
3806
3807         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3808 }
3809
3810 #[test]
3811 fn test_simple_manager_serialize_deserialize() {
3812         let chanmon_cfgs = create_chanmon_cfgs(2);
3813         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3814         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3815         let fee_estimator: test_utils::TestFeeEstimator;
3816         let new_chan_monitor: test_utils::TestChannelMonitor;
3817         let keys_manager: test_utils::TestKeysInterface;
3818         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3819         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3820         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3821
3822         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3823         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3824
3825         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3826
3827         let nodes_0_serialized = nodes[0].node.encode();
3828         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3829         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3830
3831         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3832         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);
3833         nodes[0].chan_monitor = &new_chan_monitor;
3834         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3835         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3836         assert!(chan_0_monitor_read.is_empty());
3837
3838         let mut nodes_0_read = &nodes_0_serialized[..];
3839         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3840         let (_, nodes_0_deserialized_tmp) = {
3841                 let mut channel_monitors = HashMap::new();
3842                 channel_monitors.insert(chan_0_monitor.get_funding_txo(), &mut chan_0_monitor);
3843                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3844                         default_config: UserConfig::default(),
3845                         keys_manager: &keys_manager,
3846                         fee_estimator: &fee_estimator,
3847                         monitor: nodes[0].chan_monitor,
3848                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3849                         logger: Arc::new(test_utils::TestLogger::new()),
3850                         channel_monitors: &mut channel_monitors,
3851                 }).unwrap()
3852         };
3853         nodes_0_deserialized = nodes_0_deserialized_tmp;
3854         assert!(nodes_0_read.is_empty());
3855
3856         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo(), chan_0_monitor).is_ok());
3857         nodes[0].node = &nodes_0_deserialized;
3858         check_added_monitors!(nodes[0], 1);
3859
3860         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3861
3862         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3863         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3864 }
3865
3866 #[test]
3867 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3868         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3869         let chanmon_cfgs = create_chanmon_cfgs(4);
3870         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3871         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3872         let fee_estimator: test_utils::TestFeeEstimator;
3873         let new_chan_monitor: test_utils::TestChannelMonitor;
3874         let keys_manager: test_utils::TestKeysInterface;
3875         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3876         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3877         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3878         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3879         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3880
3881         let mut node_0_stale_monitors_serialized = Vec::new();
3882         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3883                 let mut writer = test_utils::TestVecWriter(Vec::new());
3884                 monitor.1.write_for_disk(&mut writer).unwrap();
3885                 node_0_stale_monitors_serialized.push(writer.0);
3886         }
3887
3888         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3889
3890         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3891         let nodes_0_serialized = nodes[0].node.encode();
3892
3893         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3894         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3895         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3896         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3897
3898         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3899         // nodes[3])
3900         let mut node_0_monitors_serialized = Vec::new();
3901         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3902                 let mut writer = test_utils::TestVecWriter(Vec::new());
3903                 monitor.1.write_for_disk(&mut writer).unwrap();
3904                 node_0_monitors_serialized.push(writer.0);
3905         }
3906
3907         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3908         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);
3909         nodes[0].chan_monitor = &new_chan_monitor;
3910
3911         let mut node_0_stale_monitors = Vec::new();
3912         for serialized in node_0_stale_monitors_serialized.iter() {
3913                 let mut read = &serialized[..];
3914                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3915                 assert!(read.is_empty());
3916                 node_0_stale_monitors.push(monitor);
3917         }
3918
3919         let mut node_0_monitors = Vec::new();
3920         for serialized in node_0_monitors_serialized.iter() {
3921                 let mut read = &serialized[..];
3922                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3923                 assert!(read.is_empty());
3924                 node_0_monitors.push(monitor);
3925         }
3926
3927         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3928
3929         let mut nodes_0_read = &nodes_0_serialized[..];
3930         if let Err(msgs::DecodeError::InvalidValue) =
3931                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3932                 default_config: UserConfig::default(),
3933                 keys_manager: &keys_manager,
3934                 fee_estimator: &fee_estimator,
3935                 monitor: nodes[0].chan_monitor,
3936                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3937                 logger: Arc::new(test_utils::TestLogger::new()),
3938                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo(), monitor) }).collect(),
3939         }) { } else {
3940                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
3941         };
3942
3943         let mut nodes_0_read = &nodes_0_serialized[..];
3944         let (_, nodes_0_deserialized_tmp) =
3945                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3946                 default_config: UserConfig::default(),
3947                 keys_manager: &keys_manager,
3948                 fee_estimator: &fee_estimator,
3949                 monitor: nodes[0].chan_monitor,
3950                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3951                 logger: Arc::new(test_utils::TestLogger::new()),
3952                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo(), monitor) }).collect(),
3953         }).unwrap();
3954         nodes_0_deserialized = nodes_0_deserialized_tmp;
3955         assert!(nodes_0_read.is_empty());
3956
3957         { // Channel close should result in a commitment tx and an HTLC tx
3958                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3959                 assert_eq!(txn.len(), 2);
3960                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3961                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3962         }
3963
3964         for monitor in node_0_monitors.drain(..) {
3965                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo(), monitor).is_ok());
3966                 check_added_monitors!(nodes[0], 1);
3967         }
3968         nodes[0].node = &nodes_0_deserialized;
3969
3970         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3971         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3972         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3973         //... and we can even still claim the payment!
3974         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3975
3976         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3977         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3978         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3979         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3980         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3981         assert_eq!(msg_events.len(), 1);
3982         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3983                 match action {
3984                         &ErrorAction::SendErrorMessage { ref msg } => {
3985                                 assert_eq!(msg.channel_id, channel_id);
3986                         },
3987                         _ => panic!("Unexpected event!"),
3988                 }
3989         }
3990 }
3991
3992 macro_rules! check_spendable_outputs {
3993         ($node: expr, $der_idx: expr) => {
3994                 {
3995                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3996                         let mut txn = Vec::new();
3997                         for event in events {
3998                                 match event {
3999                                         Event::SpendableOutputs { ref outputs } => {
4000                                                 for outp in outputs {
4001                                                         match *outp {
4002                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
4003                                                                         let input = TxIn {
4004                                                                                 previous_output: outpoint.clone(),
4005                                                                                 script_sig: Script::new(),
4006                                                                                 sequence: 0,
4007                                                                                 witness: Vec::new(),
4008                                                                         };
4009                                                                         let outp = TxOut {
4010                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4011                                                                                 value: output.value,
4012                                                                         };
4013                                                                         let mut spend_tx = Transaction {
4014                                                                                 version: 2,
4015                                                                                 lock_time: 0,
4016                                                                                 input: vec![input],
4017                                                                                 output: vec![outp],
4018                                                                         };
4019                                                                         let secp_ctx = Secp256k1::new();
4020                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
4021                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4022                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4023                                                                         let remotesig = secp_ctx.sign(&sighash, key);
4024                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4025                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4026                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4027                                                                         txn.push(spend_tx);
4028                                                                 },
4029                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
4030                                                                         let input = TxIn {
4031                                                                                 previous_output: outpoint.clone(),
4032                                                                                 script_sig: Script::new(),
4033                                                                                 sequence: *to_self_delay as u32,
4034                                                                                 witness: Vec::new(),
4035                                                                         };
4036                                                                         let outp = TxOut {
4037                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4038                                                                                 value: output.value,
4039                                                                         };
4040                                                                         let mut spend_tx = Transaction {
4041                                                                                 version: 2,
4042                                                                                 lock_time: 0,
4043                                                                                 input: vec![input],
4044                                                                                 output: vec![outp],
4045                                                                         };
4046                                                                         let secp_ctx = Secp256k1::new();
4047                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
4048                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
4049                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
4050                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4051                                                                         spend_tx.input[0].witness.push(vec!());
4052                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4053                                                                         txn.push(spend_tx);
4054                                                                 },
4055                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4056                                                                         let secp_ctx = Secp256k1::new();
4057                                                                         let input = TxIn {
4058                                                                                 previous_output: outpoint.clone(),
4059                                                                                 script_sig: Script::new(),
4060                                                                                 sequence: 0,
4061                                                                                 witness: Vec::new(),
4062                                                                         };
4063                                                                         let outp = TxOut {
4064                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4065                                                                                 value: output.value,
4066                                                                         };
4067                                                                         let mut spend_tx = Transaction {
4068                                                                                 version: 2,
4069                                                                                 lock_time: 0,
4070                                                                                 input: vec![input],
4071                                                                                 output: vec![outp.clone()],
4072                                                                         };
4073                                                                         let secret = {
4074                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4075                                                                                         Ok(master_key) => {
4076                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4077                                                                                                         Ok(key) => key,
4078                                                                                                         Err(_) => panic!("Your RNG is busted"),
4079                                                                                                 }
4080                                                                                         }
4081                                                                                         Err(_) => panic!("Your rng is busted"),
4082                                                                                 }
4083                                                                         };
4084                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4085                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4086                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4087                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4088                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4089                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4090                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4091                                                                         txn.push(spend_tx);
4092                                                                 },
4093                                                         }
4094                                                 }
4095                                         },
4096                                         _ => panic!("Unexpected event"),
4097                                 };
4098                         }
4099                         txn
4100                 }
4101         }
4102 }
4103
4104 #[test]
4105 fn test_claim_sizeable_push_msat() {
4106         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4107         let chanmon_cfgs = create_chanmon_cfgs(2);
4108         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4109         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4110         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4111
4112         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4113         nodes[1].node.force_close_channel(&chan.2);
4114         check_closed_broadcast!(nodes[1], false);
4115         check_added_monitors!(nodes[1], 1);
4116         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4117         assert_eq!(node_txn.len(), 1);
4118         check_spends!(node_txn[0], chan.3);
4119         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
4120
4121         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4122         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4123         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4124
4125         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4126         assert_eq!(spend_txn.len(), 1);
4127         check_spends!(spend_txn[0], node_txn[0]);
4128 }
4129
4130 #[test]
4131 fn test_claim_on_remote_sizeable_push_msat() {
4132         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4133         // to_remote output is encumbered by a P2WPKH
4134         let chanmon_cfgs = create_chanmon_cfgs(2);
4135         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4136         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4137         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4138
4139         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4140         nodes[0].node.force_close_channel(&chan.2);
4141         check_closed_broadcast!(nodes[0], false);
4142         check_added_monitors!(nodes[0], 1);
4143
4144         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4145         assert_eq!(node_txn.len(), 1);
4146         check_spends!(node_txn[0], chan.3);
4147         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
4148
4149         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4150         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4151         check_closed_broadcast!(nodes[1], false);
4152         check_added_monitors!(nodes[1], 1);
4153         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4154
4155         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4156         assert_eq!(spend_txn.len(), 2);
4157         assert_eq!(spend_txn[0], spend_txn[1]);
4158         check_spends!(spend_txn[0], node_txn[0]);
4159 }
4160
4161 #[test]
4162 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4163         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4164         // to_remote output is encumbered by a P2WPKH
4165
4166         let chanmon_cfgs = create_chanmon_cfgs(2);
4167         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4168         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4169         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4170
4171         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
4172         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4173         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4174         assert_eq!(revoked_local_txn[0].input.len(), 1);
4175         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4176
4177         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4178         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4179         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4180         check_closed_broadcast!(nodes[1], false);
4181         check_added_monitors!(nodes[1], 1);
4182
4183         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4184         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4185         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4186         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4187
4188         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4189         assert_eq!(spend_txn.len(), 3);
4190         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4191         check_spends!(spend_txn[0], revoked_local_txn[0]);
4192         check_spends!(spend_txn[2], node_txn[0]);
4193 }
4194
4195 #[test]
4196 fn test_static_spendable_outputs_preimage_tx() {
4197         let chanmon_cfgs = create_chanmon_cfgs(2);
4198         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4199         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4200         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4201
4202         // Create some initial channels
4203         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4204
4205         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4206
4207         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4208         assert_eq!(commitment_tx[0].input.len(), 1);
4209         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4210
4211         // Settle A's commitment tx on B's chain
4212         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4213         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4214         check_added_monitors!(nodes[1], 1);
4215         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4216         check_added_monitors!(nodes[1], 1);
4217         let events = nodes[1].node.get_and_clear_pending_msg_events();
4218         match events[0] {
4219                 MessageSendEvent::UpdateHTLCs { .. } => {},
4220                 _ => panic!("Unexpected event"),
4221         }
4222         match events[1] {
4223                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4224                 _ => panic!("Unexepected event"),
4225         }
4226
4227         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4228         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4229         assert_eq!(node_txn.len(), 3);
4230         check_spends!(node_txn[0], commitment_tx[0]);
4231         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4232         check_spends!(node_txn[1], chan_1.3);
4233         check_spends!(node_txn[2], node_txn[1]);
4234
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(), 1);
4241         check_spends!(spend_txn[0], node_txn[0]);
4242 }
4243
4244 #[test]
4245 fn test_static_spendable_outputs_timeout_tx() {
4246         let chanmon_cfgs = create_chanmon_cfgs(2);
4247         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4248         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4249         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4250
4251         // Create some initial channels
4252         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4253
4254         // Rebalance the network a bit by relaying one payment through all the channels ...
4255         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4256
4257         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4258
4259         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4260         assert_eq!(commitment_tx[0].input.len(), 1);
4261         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4262
4263         // Settle A's commitment tx on B' chain
4264         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4265         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4266         check_added_monitors!(nodes[1], 1);
4267         let events = nodes[1].node.get_and_clear_pending_msg_events();
4268         match events[0] {
4269                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4270                 _ => panic!("Unexpected event"),
4271         }
4272
4273         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4274         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4275         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4276         check_spends!(node_txn[0],  commitment_tx[0].clone());
4277         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4278         check_spends!(node_txn[1], chan_1.3.clone());
4279         check_spends!(node_txn[2], node_txn[1]);
4280
4281         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4282         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4283         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4284         let events = nodes[1].node.get_and_clear_pending_events();
4285         assert_eq!(events.len(), 1);
4286         match events[0] {
4287                 Event::PaymentFailed { payment_hash, .. } => {
4288                         assert_eq!(payment_hash, our_payment_hash);
4289                 },
4290                 _ => panic!("Unexpected event"),
4291         }
4292
4293         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4294         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4295         check_spends!(spend_txn[2], node_txn[0].clone());
4296 }
4297
4298 #[test]
4299 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4300         let chanmon_cfgs = create_chanmon_cfgs(2);
4301         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4302         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4303         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4304
4305         // Create some initial channels
4306         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4307
4308         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4309         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4310         assert_eq!(revoked_local_txn[0].input.len(), 1);
4311         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4312
4313         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4314
4315         let  header = BlockHeader { version: 0x20000000, 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![revoked_local_txn[0].clone()] }, 0);
4317         check_closed_broadcast!(nodes[1], false);
4318         check_added_monitors!(nodes[1], 1);
4319
4320         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4321         assert_eq!(node_txn.len(), 2);
4322         assert_eq!(node_txn[0].input.len(), 2);
4323         check_spends!(node_txn[0], revoked_local_txn[0]);
4324
4325         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4326         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4327         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4328
4329         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4330         assert_eq!(spend_txn.len(), 1);
4331         check_spends!(spend_txn[0], node_txn[0]);
4332 }
4333
4334 #[test]
4335 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4336         let chanmon_cfgs = create_chanmon_cfgs(2);
4337         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4338         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4339         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4340
4341         // Create some initial channels
4342         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4343
4344         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4345         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4346         assert_eq!(revoked_local_txn[0].input.len(), 1);
4347         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4348
4349         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4350
4351         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4352         // A will generate HTLC-Timeout from revoked commitment tx
4353         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4354         check_closed_broadcast!(nodes[0], false);
4355         check_added_monitors!(nodes[0], 1);
4356
4357         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4358         assert_eq!(revoked_htlc_txn.len(), 2);
4359         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4360         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4361         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4362         check_spends!(revoked_htlc_txn[1], chan_1.3);
4363
4364         // B will generate justice tx from A's revoked commitment/HTLC tx
4365         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4366         check_closed_broadcast!(nodes[1], false);
4367         check_added_monitors!(nodes[1], 1);
4368
4369         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4370         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
4371         assert_eq!(node_txn[0].input.len(), 2);
4372         check_spends!(node_txn[0], revoked_local_txn[0]);
4373         check_spends!(node_txn[1], chan_1.3);
4374         assert_eq!(node_txn[2].input.len(), 1);
4375         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4376         assert_eq!(node_txn[3].input.len(), 1);
4377         check_spends!(node_txn[3], revoked_local_txn[0]);
4378
4379         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4380         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4381         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4382
4383         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4384         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4385         assert_eq!(spend_txn.len(), 2);
4386         check_spends!(spend_txn[0], node_txn[0]);
4387         check_spends!(spend_txn[1], node_txn[2]);
4388 }
4389
4390 #[test]
4391 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4392         let chanmon_cfgs = create_chanmon_cfgs(2);
4393         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4394         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4395         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4396
4397         // Create some initial channels
4398         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4399
4400         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4401         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4402         assert_eq!(revoked_local_txn[0].input.len(), 1);
4403         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4404
4405         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4406
4407         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4408         // B will generate HTLC-Success from revoked commitment tx
4409         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4410         check_closed_broadcast!(nodes[1], false);
4411         check_added_monitors!(nodes[1], 1);
4412         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4413
4414         assert_eq!(revoked_htlc_txn.len(), 2);
4415         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4416         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4417         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4418
4419         // A will generate justice tx from B's revoked commitment/HTLC tx
4420         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4421         check_closed_broadcast!(nodes[0], false);
4422         check_added_monitors!(nodes[0], 1);
4423
4424         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4425         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4426         assert_eq!(node_txn[2].input.len(), 1);
4427         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4428
4429         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4430         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4431         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4432
4433         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4434         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4435         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
4436         assert_eq!(spend_txn[0], spend_txn[1]);
4437         assert_eq!(spend_txn[0], spend_txn[2]);
4438         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4439         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
4440         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
4441 }
4442
4443 #[test]
4444 fn test_onchain_to_onchain_claim() {
4445         // Test that in case of channel closure, we detect the state of output thanks to
4446         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4447         // First, have C claim an HTLC against its own latest commitment transaction.
4448         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4449         // channel.
4450         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4451         // gets broadcast.
4452
4453         let chanmon_cfgs = create_chanmon_cfgs(3);
4454         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4455         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4456         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4457
4458         // Create some initial channels
4459         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4460         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4461
4462         // Rebalance the network a bit by relaying one payment through all the channels ...
4463         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4464         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4465
4466         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4467         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4468         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4469         check_spends!(commitment_tx[0], chan_2.3);
4470         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
4471         check_added_monitors!(nodes[2], 1);
4472         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4473         assert!(updates.update_add_htlcs.is_empty());
4474         assert!(updates.update_fail_htlcs.is_empty());
4475         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4476         assert!(updates.update_fail_malformed_htlcs.is_empty());
4477
4478         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4479         check_closed_broadcast!(nodes[2], false);
4480         check_added_monitors!(nodes[2], 1);
4481
4482         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4483         assert_eq!(c_txn.len(), 3);
4484         assert_eq!(c_txn[0], c_txn[2]);
4485         assert_eq!(commitment_tx[0], c_txn[1]);
4486         check_spends!(c_txn[1], chan_2.3);
4487         check_spends!(c_txn[2], c_txn[1]);
4488         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4489         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4490         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4491         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4492
4493         // 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
4494         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4495         {
4496                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4497                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4498                 assert_eq!(b_txn.len(), 3);
4499                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4500                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4501                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4502                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4503                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4504                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4505                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4506                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4507                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4508                 b_txn.clear();
4509         }
4510         check_added_monitors!(nodes[1], 1);
4511         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4512         check_added_monitors!(nodes[1], 1);
4513         match msg_events[0] {
4514                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4515                 _ => panic!("Unexpected event"),
4516         }
4517         match msg_events[1] {
4518                 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, .. } } => {
4519                         assert!(update_add_htlcs.is_empty());
4520                         assert!(update_fail_htlcs.is_empty());
4521                         assert_eq!(update_fulfill_htlcs.len(), 1);
4522                         assert!(update_fail_malformed_htlcs.is_empty());
4523                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4524                 },
4525                 _ => panic!("Unexpected event"),
4526         };
4527         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4528         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4529         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4530         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4531         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4532         assert_eq!(b_txn.len(), 3);
4533         check_spends!(b_txn[1], chan_1.3);
4534         check_spends!(b_txn[2], b_txn[1]);
4535         check_spends!(b_txn[0], commitment_tx[0]);
4536         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4537         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4538         assert_eq!(b_txn[0].lock_time, 0); // Success tx
4539
4540         check_closed_broadcast!(nodes[1], false);
4541         check_added_monitors!(nodes[1], 1);
4542 }
4543
4544 #[test]
4545 fn test_duplicate_payment_hash_one_failure_one_success() {
4546         // Topology : A --> B --> C
4547         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4548         let chanmon_cfgs = create_chanmon_cfgs(3);
4549         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4550         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4551         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4552
4553         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4554         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4555
4556         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4557         *nodes[0].network_payment_count.borrow_mut() -= 1;
4558         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4559
4560         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
4561         assert_eq!(commitment_txn[0].input.len(), 1);
4562         check_spends!(commitment_txn[0], chan_2.3);
4563
4564         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4565         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4566         check_closed_broadcast!(nodes[1], false);
4567         check_added_monitors!(nodes[1], 1);
4568
4569         let htlc_timeout_tx;
4570         { // Extract one of the two HTLC-Timeout transaction
4571                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4572                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
4573                 assert_eq!(node_txn.len(), 5);
4574                 check_spends!(node_txn[0], commitment_txn[0]);
4575                 assert_eq!(node_txn[0].input.len(), 1);
4576                 check_spends!(node_txn[1], commitment_txn[0]);
4577                 assert_eq!(node_txn[1].input.len(), 1);
4578                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4579                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4580                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4581                 check_spends!(node_txn[2], chan_2.3);
4582                 check_spends!(node_txn[3], node_txn[2]);
4583                 check_spends!(node_txn[4], node_txn[2]);
4584                 htlc_timeout_tx = node_txn[1].clone();
4585         }
4586
4587         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
4588         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4589         check_added_monitors!(nodes[2], 3);
4590         let events = nodes[2].node.get_and_clear_pending_msg_events();
4591         match events[0] {
4592                 MessageSendEvent::UpdateHTLCs { .. } => {},
4593                 _ => panic!("Unexpected event"),
4594         }
4595         match events[1] {
4596                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4597                 _ => panic!("Unexepected event"),
4598         }
4599         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4600         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)
4601         check_spends!(htlc_success_txn[2], chan_2.3);
4602         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4603         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4604         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
4605         assert_eq!(htlc_success_txn[0].input.len(), 1);
4606         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4607         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4608         assert_eq!(htlc_success_txn[1].input.len(), 1);
4609         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4610         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4611         check_spends!(htlc_success_txn[0], commitment_txn[0]);
4612         check_spends!(htlc_success_txn[1], commitment_txn[0]);
4613
4614         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4615         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4616         expect_pending_htlcs_forwardable!(nodes[1]);
4617         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4618         assert!(htlc_updates.update_add_htlcs.is_empty());
4619         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4620         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4621         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4622         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4623         check_added_monitors!(nodes[1], 1);
4624
4625         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4626         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4627         {
4628                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4629                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4630                 assert_eq!(events.len(), 1);
4631                 match events[0] {
4632                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4633                         },
4634                         _ => { panic!("Unexpected event"); }
4635                 }
4636         }
4637         let events = nodes[0].node.get_and_clear_pending_events();
4638         match events[0] {
4639                 Event::PaymentFailed { ref payment_hash, .. } => {
4640                         assert_eq!(*payment_hash, duplicate_payment_hash);
4641                 }
4642                 _ => panic!("Unexpected event"),
4643         }
4644
4645         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4646         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4647         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4648         assert!(updates.update_add_htlcs.is_empty());
4649         assert!(updates.update_fail_htlcs.is_empty());
4650         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4651         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4652         assert!(updates.update_fail_malformed_htlcs.is_empty());
4653         check_added_monitors!(nodes[1], 1);
4654
4655         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4656         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4657
4658         let events = nodes[0].node.get_and_clear_pending_events();
4659         match events[0] {
4660                 Event::PaymentSent { ref payment_preimage } => {
4661                         assert_eq!(*payment_preimage, our_payment_preimage);
4662                 }
4663                 _ => panic!("Unexpected event"),
4664         }
4665 }
4666
4667 #[test]
4668 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4669         let chanmon_cfgs = create_chanmon_cfgs(2);
4670         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4671         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4672         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4673
4674         // Create some initial channels
4675         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4676
4677         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4678         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4679         assert_eq!(local_txn[0].input.len(), 1);
4680         check_spends!(local_txn[0], chan_1.3);
4681
4682         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4683         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
4684         check_added_monitors!(nodes[1], 1);
4685         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4686         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4687         check_added_monitors!(nodes[1], 1);
4688         let events = nodes[1].node.get_and_clear_pending_msg_events();
4689         match events[0] {
4690                 MessageSendEvent::UpdateHTLCs { .. } => {},
4691                 _ => panic!("Unexpected event"),
4692         }
4693         match events[1] {
4694                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4695                 _ => panic!("Unexepected event"),
4696         }
4697         let node_txn = {
4698                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4699                 assert_eq!(node_txn[0].input.len(), 1);
4700                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4701                 check_spends!(node_txn[0], local_txn[0]);
4702                 vec![node_txn[0].clone(), node_txn[2].clone()]
4703         };
4704
4705         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4706         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
4707         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
4708
4709         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4710         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4711         assert_eq!(spend_txn.len(), 2);
4712         check_spends!(spend_txn[0], node_txn[0]);
4713         check_spends!(spend_txn[1], node_txn[1]);
4714 }
4715
4716 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4717         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4718         // unrevoked commitment transaction.
4719         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4720         // a remote RAA before they could be failed backwards (and combinations thereof).
4721         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4722         // use the same payment hashes.
4723         // Thus, we use a six-node network:
4724         //
4725         // A \         / E
4726         //    - C - D -
4727         // B /         \ F
4728         // And test where C fails back to A/B when D announces its latest commitment transaction
4729         let chanmon_cfgs = create_chanmon_cfgs(6);
4730         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4731         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4732         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4733
4734         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4735         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4736         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4737         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4738         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4739
4740         // Rebalance and check output sanity...
4741         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4742         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4743         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
4744
4745         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4746         // 0th HTLC:
4747         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
4748         // 1st HTLC:
4749         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
4750         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();
4751         // 2nd HTLC:
4752         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
4753         // 3rd HTLC:
4754         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
4755         // 4th HTLC:
4756         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4757         // 5th HTLC:
4758         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4759         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4760         // 6th HTLC:
4761         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4762         // 7th HTLC:
4763         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4764
4765         // 8th HTLC:
4766         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4767         // 9th HTLC:
4768         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();
4769         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
4770
4771         // 10th HTLC:
4772         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
4773         // 11th HTLC:
4774         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4775         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4776
4777         // Double-check that six of the new HTLC were added
4778         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4779         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4780         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
4781         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
4782
4783         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4784         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4785         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
4786         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
4787         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
4788         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
4789         check_added_monitors!(nodes[4], 0);
4790         expect_pending_htlcs_forwardable!(nodes[4]);
4791         check_added_monitors!(nodes[4], 1);
4792
4793         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4794         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4795         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4796         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4797         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4798         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4799
4800         // Fail 3rd below-dust and 7th above-dust HTLCs
4801         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
4802         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
4803         check_added_monitors!(nodes[5], 0);
4804         expect_pending_htlcs_forwardable!(nodes[5]);
4805         check_added_monitors!(nodes[5], 1);
4806
4807         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4808         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4809         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4810         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4811
4812         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4813
4814         expect_pending_htlcs_forwardable!(nodes[3]);
4815         check_added_monitors!(nodes[3], 1);
4816         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4817         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4818         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4819         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4820         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4821         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4822         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4823         if deliver_last_raa {
4824                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4825         } else {
4826                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4827         }
4828
4829         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4830         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4831         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4832         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4833         //
4834         // We now broadcast the latest commitment transaction, which *should* result in failures for
4835         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4836         // the non-broadcast above-dust HTLCs.
4837         //
4838         // Alternatively, we may broadcast the previous commitment transaction, which should only
4839         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4840         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4841
4842         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4843         if announce_latest {
4844                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4845         } else {
4846                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4847         }
4848         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4849         check_closed_broadcast!(nodes[2], false);
4850         expect_pending_htlcs_forwardable!(nodes[2]);
4851         check_added_monitors!(nodes[2], 3);
4852
4853         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4854         assert_eq!(cs_msgs.len(), 2);
4855         let mut a_done = false;
4856         for msg in cs_msgs {
4857                 match msg {
4858                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4859                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4860                                 // should be failed-backwards here.
4861                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4862                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4863                                         for htlc in &updates.update_fail_htlcs {
4864                                                 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 });
4865                                         }
4866                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4867                                         assert!(!a_done);
4868                                         a_done = true;
4869                                         &nodes[0]
4870                                 } else {
4871                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4872                                         for htlc in &updates.update_fail_htlcs {
4873                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4874                                         }
4875                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4876                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4877                                         &nodes[1]
4878                                 };
4879                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4880                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4881                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4882                                 if announce_latest {
4883                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4884                                         if *node_id == nodes[0].node.get_our_node_id() {
4885                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4886                                         }
4887                                 }
4888                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4889                         },
4890                         _ => panic!("Unexpected event"),
4891                 }
4892         }
4893
4894         let as_events = nodes[0].node.get_and_clear_pending_events();
4895         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4896         let mut as_failds = HashSet::new();
4897         for event in as_events.iter() {
4898                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4899                         assert!(as_failds.insert(*payment_hash));
4900                         if *payment_hash != payment_hash_2 {
4901                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4902                         } else {
4903                                 assert!(!rejected_by_dest);
4904                         }
4905                 } else { panic!("Unexpected event"); }
4906         }
4907         assert!(as_failds.contains(&payment_hash_1));
4908         assert!(as_failds.contains(&payment_hash_2));
4909         if announce_latest {
4910                 assert!(as_failds.contains(&payment_hash_3));
4911                 assert!(as_failds.contains(&payment_hash_5));
4912         }
4913         assert!(as_failds.contains(&payment_hash_6));
4914
4915         let bs_events = nodes[1].node.get_and_clear_pending_events();
4916         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4917         let mut bs_failds = HashSet::new();
4918         for event in bs_events.iter() {
4919                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4920                         assert!(bs_failds.insert(*payment_hash));
4921                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4922                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4923                         } else {
4924                                 assert!(!rejected_by_dest);
4925                         }
4926                 } else { panic!("Unexpected event"); }
4927         }
4928         assert!(bs_failds.contains(&payment_hash_1));
4929         assert!(bs_failds.contains(&payment_hash_2));
4930         if announce_latest {
4931                 assert!(bs_failds.contains(&payment_hash_4));
4932         }
4933         assert!(bs_failds.contains(&payment_hash_5));
4934
4935         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4936         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4937         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4938         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4939         // PaymentFailureNetworkUpdates.
4940         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4941         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4942         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4943         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4944         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4945                 match event {
4946                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4947                         _ => panic!("Unexpected event"),
4948                 }
4949         }
4950 }
4951
4952 #[test]
4953 fn test_fail_backwards_latest_remote_announce_a() {
4954         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4955 }
4956
4957 #[test]
4958 fn test_fail_backwards_latest_remote_announce_b() {
4959         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4960 }
4961
4962 #[test]
4963 fn test_fail_backwards_previous_remote_announce() {
4964         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4965         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4966         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4967 }
4968
4969 #[test]
4970 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4971         let chanmon_cfgs = create_chanmon_cfgs(2);
4972         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4973         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4974         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4975
4976         // Create some initial channels
4977         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4978
4979         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
4980         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4981         assert_eq!(local_txn[0].input.len(), 1);
4982         check_spends!(local_txn[0], chan_1.3);
4983
4984         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4985         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4986         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4987         check_closed_broadcast!(nodes[0], false);
4988         check_added_monitors!(nodes[0], 1);
4989
4990         let htlc_timeout = {
4991                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4992                 assert_eq!(node_txn[0].input.len(), 1);
4993                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4994                 check_spends!(node_txn[0], local_txn[0]);
4995                 node_txn[0].clone()
4996         };
4997
4998         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4999         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5000         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5001         let events = nodes[0].node.get_and_clear_pending_events();
5002         assert_eq!(events.len(), 1);
5003         match events[0] {
5004                 Event::PaymentFailed { payment_hash, .. } => {
5005                         assert_eq!(payment_hash, our_payment_hash);
5006                 },
5007                 _ => panic!("Unexpected event"),
5008         }
5009
5010         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5011         let spend_txn = check_spendable_outputs!(nodes[0], 1);
5012         assert_eq!(spend_txn.len(), 3);
5013         assert_eq!(spend_txn[0], spend_txn[1]);
5014         check_spends!(spend_txn[0], local_txn[0]);
5015         check_spends!(spend_txn[2], htlc_timeout);
5016 }
5017
5018 #[test]
5019 fn test_static_output_closing_tx() {
5020         let chanmon_cfgs = create_chanmon_cfgs(2);
5021         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5022         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5023         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5024
5025         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5026
5027         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5028         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5029
5030         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5031         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5032         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5033
5034         let spend_txn = check_spendable_outputs!(nodes[0], 2);
5035         assert_eq!(spend_txn.len(), 1);
5036         check_spends!(spend_txn[0], closing_tx);
5037
5038         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5039         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5040
5041         let spend_txn = check_spendable_outputs!(nodes[1], 2);
5042         assert_eq!(spend_txn.len(), 1);
5043         check_spends!(spend_txn[0], closing_tx);
5044 }
5045
5046 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5047         let chanmon_cfgs = create_chanmon_cfgs(2);
5048         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5049         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5050         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5051         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5052
5053         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5054
5055         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5056         // present in B's local commitment transaction, but none of A's commitment transactions.
5057         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5058         check_added_monitors!(nodes[1], 1);
5059
5060         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5061         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5062         let events = nodes[0].node.get_and_clear_pending_events();
5063         assert_eq!(events.len(), 1);
5064         match events[0] {
5065                 Event::PaymentSent { payment_preimage } => {
5066                         assert_eq!(payment_preimage, our_payment_preimage);
5067                 },
5068                 _ => panic!("Unexpected event"),
5069         }
5070
5071         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5072         check_added_monitors!(nodes[0], 1);
5073         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5074         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5075         check_added_monitors!(nodes[1], 1);
5076
5077         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5078         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5079                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5080                 header.prev_blockhash = header.bitcoin_hash();
5081         }
5082         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5083         check_closed_broadcast!(nodes[1], false);
5084         check_added_monitors!(nodes[1], 1);
5085 }
5086
5087 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5088         let chanmon_cfgs = create_chanmon_cfgs(2);
5089         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5090         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5091         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5092         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5093
5094         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();
5095         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5096         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5097         check_added_monitors!(nodes[0], 1);
5098
5099         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5100
5101         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5102         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5103         // to "time out" the HTLC.
5104
5105         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5106
5107         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5108                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5109                 header.prev_blockhash = header.bitcoin_hash();
5110         }
5111         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5112         check_closed_broadcast!(nodes[0], false);
5113         check_added_monitors!(nodes[0], 1);
5114 }
5115
5116 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5117         let chanmon_cfgs = create_chanmon_cfgs(3);
5118         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5119         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5120         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5121         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5122
5123         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5124         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5125         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5126         // actually revoked.
5127         let htlc_value = if use_dust { 50000 } else { 3000000 };
5128         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5129         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5130         expect_pending_htlcs_forwardable!(nodes[1]);
5131         check_added_monitors!(nodes[1], 1);
5132
5133         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5134         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5135         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5136         check_added_monitors!(nodes[0], 1);
5137         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5138         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5139         check_added_monitors!(nodes[1], 1);
5140         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5141         check_added_monitors!(nodes[1], 1);
5142         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5143
5144         if check_revoke_no_close {
5145                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5146                 check_added_monitors!(nodes[0], 1);
5147         }
5148
5149         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5150         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5151                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5152                 header.prev_blockhash = header.bitcoin_hash();
5153         }
5154         if !check_revoke_no_close {
5155                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5156                 check_closed_broadcast!(nodes[0], false);
5157                 check_added_monitors!(nodes[0], 1);
5158         } else {
5159                 let events = nodes[0].node.get_and_clear_pending_events();
5160                 assert_eq!(events.len(), 1);
5161                 match events[0] {
5162                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
5163                                 assert_eq!(payment_hash, our_payment_hash);
5164                                 assert!(rejected_by_dest);
5165                         },
5166                         _ => panic!("Unexpected event"),
5167                 }
5168         }
5169 }
5170
5171 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5172 // There are only a few cases to test here:
5173 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5174 //    broadcastable commitment transactions result in channel closure,
5175 //  * its included in an unrevoked-but-previous remote commitment transaction,
5176 //  * its included in the latest remote or local commitment transactions.
5177 // We test each of the three possible commitment transactions individually and use both dust and
5178 // non-dust HTLCs.
5179 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5180 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5181 // tested for at least one of the cases in other tests.
5182 #[test]
5183 fn htlc_claim_single_commitment_only_a() {
5184         do_htlc_claim_local_commitment_only(true);
5185         do_htlc_claim_local_commitment_only(false);
5186
5187         do_htlc_claim_current_remote_commitment_only(true);
5188         do_htlc_claim_current_remote_commitment_only(false);
5189 }
5190
5191 #[test]
5192 fn htlc_claim_single_commitment_only_b() {
5193         do_htlc_claim_previous_remote_commitment_only(true, false);
5194         do_htlc_claim_previous_remote_commitment_only(false, false);
5195         do_htlc_claim_previous_remote_commitment_only(true, true);
5196         do_htlc_claim_previous_remote_commitment_only(false, true);
5197 }
5198
5199 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>)
5200         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5201                                 F2: FnMut(),
5202 {
5203         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);
5204 }
5205
5206 // test_case
5207 // 0: node1 fails backward
5208 // 1: final node fails backward
5209 // 2: payment completed but the user rejects the payment
5210 // 3: final node fails backward (but tamper onion payloads from node0)
5211 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5212 // 200: trigger error in the final node and tamper returning fail_htlc
5213 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>)
5214         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5215                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5216                                 F3: FnMut(),
5217 {
5218
5219         // reset block height
5220         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5221         for ix in 0..nodes.len() {
5222                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5223         }
5224
5225         macro_rules! expect_event {
5226                 ($node: expr, $event_type: path) => {{
5227                         let events = $node.node.get_and_clear_pending_events();
5228                         assert_eq!(events.len(), 1);
5229                         match events[0] {
5230                                 $event_type { .. } => {},
5231                                 _ => panic!("Unexpected event"),
5232                         }
5233                 }}
5234         }
5235
5236         macro_rules! expect_htlc_forward {
5237                 ($node: expr) => {{
5238                         expect_event!($node, Event::PendingHTLCsForwardable);
5239                         $node.node.process_pending_htlc_forwards();
5240                 }}
5241         }
5242
5243         // 0 ~~> 2 send payment
5244         nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5245         check_added_monitors!(nodes[0], 1);
5246         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5247         // temper update_add (0 => 1)
5248         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5249         if test_case == 0 || test_case == 3 || test_case == 100 {
5250                 callback_msg(&mut update_add_0);
5251                 callback_node();
5252         }
5253         // 0 => 1 update_add & CS
5254         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5255         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5256
5257         let update_1_0 = match test_case {
5258                 0|100 => { // intermediate node failure; fail backward to 0
5259                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5260                         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));
5261                         update_1_0
5262                 },
5263                 1|2|3|200 => { // final node failure; forwarding to 2
5264                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5265                         // forwarding on 1
5266                         if test_case != 200 {
5267                                 callback_node();
5268                         }
5269                         expect_htlc_forward!(&nodes[1]);
5270
5271                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5272                         check_added_monitors!(&nodes[1], 1);
5273                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5274                         // tamper update_add (1 => 2)
5275                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5276                         if test_case != 3 && test_case != 200 {
5277                                 callback_msg(&mut update_add_1);
5278                         }
5279
5280                         // 1 => 2
5281                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5282                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5283
5284                         if test_case == 2 || test_case == 200 {
5285                                 expect_htlc_forward!(&nodes[2]);
5286                                 expect_event!(&nodes[2], Event::PaymentReceived);
5287                                 callback_node();
5288                                 expect_pending_htlcs_forwardable!(nodes[2]);
5289                         }
5290
5291                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5292                         if test_case == 2 || test_case == 200 {
5293                                 check_added_monitors!(&nodes[2], 1);
5294                         }
5295                         assert!(update_2_1.update_fail_htlcs.len() == 1);
5296
5297                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5298                         if test_case == 200 {
5299                                 callback_fail(&mut fail_msg);
5300                         }
5301
5302                         // 2 => 1
5303                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5304                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5305
5306                         // backward fail on 1
5307                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5308                         assert!(update_1_0.update_fail_htlcs.len() == 1);
5309                         update_1_0
5310                 },
5311                 _ => unreachable!(),
5312         };
5313
5314         // 1 => 0 commitment_signed_dance
5315         if update_1_0.update_fail_htlcs.len() > 0 {
5316                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5317                 if test_case == 100 {
5318                         callback_fail(&mut fail_msg);
5319                 }
5320                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5321         } else {
5322                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5323         };
5324
5325         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5326
5327         let events = nodes[0].node.get_and_clear_pending_events();
5328         assert_eq!(events.len(), 1);
5329         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, error_data: _ } = &events[0] {
5330                 assert_eq!(*rejected_by_dest, !expected_retryable);
5331                 assert_eq!(*error_code, expected_error_code);
5332         } else {
5333                 panic!("Uexpected event");
5334         }
5335
5336         let events = nodes[0].node.get_and_clear_pending_msg_events();
5337         if expected_channel_update.is_some() {
5338                 assert_eq!(events.len(), 1);
5339                 match events[0] {
5340                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5341                                 match update {
5342                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5343                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5344                                                         panic!("channel_update not found!");
5345                                                 }
5346                                         },
5347                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5348                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5349                                                         assert!(*short_channel_id == *expected_short_channel_id);
5350                                                         assert!(*is_permanent == *expected_is_permanent);
5351                                                 } else {
5352                                                         panic!("Unexpected message event");
5353                                                 }
5354                                         },
5355                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5356                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5357                                                         assert!(*node_id == *expected_node_id);
5358                                                         assert!(*is_permanent == *expected_is_permanent);
5359                                                 } else {
5360                                                         panic!("Unexpected message event");
5361                                                 }
5362                                         },
5363                                 }
5364                         },
5365                         _ => panic!("Unexpected message event"),
5366                 }
5367         } else {
5368                 assert_eq!(events.len(), 0);
5369         }
5370 }
5371
5372 impl msgs::ChannelUpdate {
5373         fn dummy() -> msgs::ChannelUpdate {
5374                 use secp256k1::ffi::Signature as FFISignature;
5375                 use secp256k1::Signature;
5376                 msgs::ChannelUpdate {
5377                         signature: Signature::from(FFISignature::new()),
5378                         contents: msgs::UnsignedChannelUpdate {
5379                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5380                                 short_channel_id: 0,
5381                                 timestamp: 0,
5382                                 flags: 0,
5383                                 cltv_expiry_delta: 0,
5384                                 htlc_minimum_msat: 0,
5385                                 fee_base_msat: 0,
5386                                 fee_proportional_millionths: 0,
5387                                 excess_data: vec![],
5388                         }
5389                 }
5390         }
5391 }
5392
5393 struct BogusOnionHopData {
5394         data: Vec<u8>
5395 }
5396 impl BogusOnionHopData {
5397         fn new(orig: msgs::OnionHopData) -> Self {
5398                 Self { data: orig.encode() }
5399         }
5400 }
5401 impl Writeable for BogusOnionHopData {
5402         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5403                 writer.write_all(&self.data[..])
5404         }
5405 }
5406
5407 #[test]
5408 fn test_onion_failure() {
5409         use ln::msgs::ChannelUpdate;
5410         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5411         use secp256k1;
5412
5413         const BADONION: u16 = 0x8000;
5414         const PERM: u16 = 0x4000;
5415         const NODE: u16 = 0x2000;
5416         const UPDATE: u16 = 0x1000;
5417
5418         let chanmon_cfgs = create_chanmon_cfgs(3);
5419         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5420         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5421         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5422         for node in nodes.iter() {
5423                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5424         }
5425         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())];
5426         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5427         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5428         // positve case
5429         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5430
5431         // intermediate node failure
5432         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5433                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5434                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5435                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5436                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5437                 let mut new_payloads = Vec::new();
5438                 for payload in onion_payloads.drain(..) {
5439                         new_payloads.push(BogusOnionHopData::new(payload));
5440                 }
5441                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5442                 // describing a length-1 TLV payload, which is obviously bogus.
5443                 new_payloads[0].data[0] = 1;
5444                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5445         }, ||{}, 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
5446
5447         // final node failure
5448         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5449                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5450                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5451                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5452                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5453                 let mut new_payloads = Vec::new();
5454                 for payload in onion_payloads.drain(..) {
5455                         new_payloads.push(BogusOnionHopData::new(payload));
5456                 }
5457                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5458                 // length-1 TLV payload, which is obviously bogus.
5459                 new_payloads[1].data[0] = 1;
5460                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5461         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5462
5463         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5464         // receiving simulated fail messages
5465         // intermediate node failure
5466         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5467                 // trigger error
5468                 msg.amount_msat -= 1;
5469         }, |msg| {
5470                 // and tamper returning error message
5471                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5472                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5473                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5474         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
5475
5476         // final node failure
5477         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5478                 // and tamper returning error message
5479                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5480                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5481                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5482         }, ||{
5483                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5484         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
5485
5486         // intermediate node failure
5487         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5488                 msg.amount_msat -= 1;
5489         }, |msg| {
5490                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5491                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5492                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5493         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5494
5495         // final node failure
5496         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5497                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5498                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5499                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5500         }, ||{
5501                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5502         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5503
5504         // intermediate node failure
5505         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5506                 msg.amount_msat -= 1;
5507         }, |msg| {
5508                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5509                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5510                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5511         }, ||{
5512                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5513         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5514
5515         // final node failure
5516         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5517                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5518                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5519                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5520         }, ||{
5521                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5522         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5523
5524         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5525                 Some(BADONION|PERM|4), None);
5526
5527         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5528                 Some(BADONION|PERM|5), None);
5529
5530         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5531                 Some(BADONION|PERM|6), None);
5532
5533         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5534                 msg.amount_msat -= 1;
5535         }, |msg| {
5536                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5537                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5538                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5539         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5540
5541         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5542                 msg.amount_msat -= 1;
5543         }, |msg| {
5544                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5545                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5546                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5547                 // short_channel_id from the processing node
5548         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5549
5550         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5551                 msg.amount_msat -= 1;
5552         }, |msg| {
5553                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5554                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5555                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5556                 // short_channel_id from the processing node
5557         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5558
5559         let mut bogus_route = route.clone();
5560         bogus_route.paths[0][1].short_channel_id -= 1;
5561         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5562           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
5563
5564         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5565         let mut bogus_route = route.clone();
5566         let route_len = bogus_route.paths[0].len();
5567         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
5568         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5569
5570         //TODO: with new config API, we will be able to generate both valid and
5571         //invalid channel_update cases.
5572         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5573                 msg.amount_msat -= 1;
5574         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5575
5576         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5577                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5578                 msg.cltv_expiry -= 1;
5579         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5580
5581         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5582                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5583                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5584
5585                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5586         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5587
5588         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5589                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5590         }, false, Some(PERM|15), None);
5591
5592         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5593                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5594                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5595
5596                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5597         }, || {}, true, Some(17), None);
5598
5599         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5600                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5601                         for f in pending_forwards.iter_mut() {
5602                                 match f {
5603                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5604                                                 forward_info.outgoing_cltv_value += 1,
5605                                         _ => {},
5606                                 }
5607                         }
5608                 }
5609         }, true, Some(18), None);
5610
5611         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5612                 // violate amt_to_forward > msg.amount_msat
5613                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5614                         for f in pending_forwards.iter_mut() {
5615                                 match f {
5616                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5617                                                 forward_info.amt_to_forward -= 1,
5618                                         _ => {},
5619                                 }
5620                         }
5621                 }
5622         }, true, Some(19), None);
5623
5624         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5625                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5626                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5627                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5628         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5629         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5630
5631         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5632                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5633                 let mut route = route.clone();
5634                 let height = 1;
5635                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
5636                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5637                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
5638                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5639                 msg.cltv_expiry = htlc_cltv;
5640                 msg.onion_routing_packet = onion_packet;
5641         }, ||{}, true, Some(21), None);
5642 }
5643
5644 #[test]
5645 #[should_panic]
5646 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5647         let chanmon_cfgs = create_chanmon_cfgs(2);
5648         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5649         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5650         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5651         //Force duplicate channel ids
5652         for node in nodes.iter() {
5653                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5654         }
5655
5656         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5657         let channel_value_satoshis=10000;
5658         let push_msat=10001;
5659         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5660         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5661         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5662
5663         //Create a second channel with a channel_id collision
5664         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5665 }
5666
5667 #[test]
5668 fn bolt2_open_channel_sending_node_checks_part2() {
5669         let chanmon_cfgs = create_chanmon_cfgs(2);
5670         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5671         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5672         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5673
5674         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5675         let channel_value_satoshis=2^24;
5676         let push_msat=10001;
5677         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5678
5679         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5680         let channel_value_satoshis=10000;
5681         // Test when push_msat is equal to 1000 * funding_satoshis.
5682         let push_msat=1000*channel_value_satoshis+1;
5683         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5684
5685         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5686         let channel_value_satoshis=10000;
5687         let push_msat=10001;
5688         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
5689         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5690         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5691
5692         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5693         // 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
5694         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5695
5696         // 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.
5697         assert!(BREAKDOWN_TIMEOUT>0);
5698         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5699
5700         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5701         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5702         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5703
5704         // 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.
5705         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5706         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5707         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5708         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5709         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5710 }
5711
5712 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5713 // 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.
5714 //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.
5715
5716 #[test]
5717 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5718         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5719         let chanmon_cfgs = create_chanmon_cfgs(2);
5720         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5721         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5722         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5723         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5724         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5725         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5726
5727         route.paths[0][0].fee_msat = 100;
5728
5729         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5730                 assert_eq!(err, "Cannot send less than their minimum HTLC value"));
5731         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5732         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5733 }
5734
5735 #[test]
5736 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
5737         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5738         let chanmon_cfgs = create_chanmon_cfgs(2);
5739         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5740         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5741         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5742         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5743         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5744         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5745
5746         route.paths[0][0].fee_msat = 0;
5747
5748         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5749                 assert_eq!(err, "Cannot send 0-msat HTLC"));
5750         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5751         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
5752 }
5753
5754 #[test]
5755 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
5756         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5757         let chanmon_cfgs = create_chanmon_cfgs(2);
5758         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5759         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5760         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5761         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5762         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5763         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5764
5765         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5766         check_added_monitors!(nodes[0], 1);
5767         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5768         updates.update_add_htlcs[0].amount_msat = 0;
5769
5770         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5771         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
5772         check_closed_broadcast!(nodes[1], true).unwrap();
5773         check_added_monitors!(nodes[1], 1);
5774 }
5775
5776 #[test]
5777 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5778         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5779         //It is enforced when constructing a route.
5780         let chanmon_cfgs = create_chanmon_cfgs(2);
5781         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5782         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5783         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5784         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5785         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5786         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5787
5788         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { err },
5789                 assert_eq!(err, "Channel CLTV overflowed?!"));
5790 }
5791
5792 #[test]
5793 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5794         //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.
5795         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5796         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5797         let chanmon_cfgs = create_chanmon_cfgs(2);
5798         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5799         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5800         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5801         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5802         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5803
5804         for i in 0..max_accepted_htlcs {
5805                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5806                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5807                 let payment_event = {
5808                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5809                         check_added_monitors!(nodes[0], 1);
5810
5811                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5812                         assert_eq!(events.len(), 1);
5813                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5814                                 assert_eq!(htlcs[0].htlc_id, i);
5815                         } else {
5816                                 assert!(false);
5817                         }
5818                         SendEvent::from_event(events.remove(0))
5819                 };
5820                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5821                 check_added_monitors!(nodes[1], 0);
5822                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5823
5824                 expect_pending_htlcs_forwardable!(nodes[1]);
5825                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5826         }
5827         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5828         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5829         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5830                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
5831
5832         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5833         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5834 }
5835
5836 #[test]
5837 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5838         //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.
5839         let chanmon_cfgs = create_chanmon_cfgs(2);
5840         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5841         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5842         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5843         let channel_value = 100000;
5844         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5845         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5846
5847         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5848
5849         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5850         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5851         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5852                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
5853
5854         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5855         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);
5856
5857         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5858 }
5859
5860 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5861 #[test]
5862 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5863         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5864         let chanmon_cfgs = create_chanmon_cfgs(2);
5865         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5866         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5867         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5868         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5869         let htlc_minimum_msat: u64;
5870         {
5871                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5872                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5873                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5874         }
5875         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5876         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5877         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5878         check_added_monitors!(nodes[0], 1);
5879         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5880         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5881         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5882         assert!(nodes[1].node.list_channels().is_empty());
5883         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5884         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5885         check_added_monitors!(nodes[1], 1);
5886 }
5887
5888 #[test]
5889 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5890         //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
5891         let chanmon_cfgs = create_chanmon_cfgs(2);
5892         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5893         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5894         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5895         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5896
5897         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5898
5899         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5900         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5901         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5902         check_added_monitors!(nodes[0], 1);
5903         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5904
5905         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5906         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5907
5908         assert!(nodes[1].node.list_channels().is_empty());
5909         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5910         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5911         check_added_monitors!(nodes[1], 1);
5912 }
5913
5914 #[test]
5915 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5916         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5917         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5918         let chanmon_cfgs = create_chanmon_cfgs(2);
5919         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5920         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5921         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5922         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5923         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5924         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5925
5926         let session_priv = SecretKey::from_slice(&{
5927                 let mut session_key = [0; 32];
5928                 let mut rng = thread_rng();
5929                 rng.fill_bytes(&mut session_key);
5930                 session_key
5931         }).expect("RNG is bad!");
5932
5933         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5934         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
5935         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
5936         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5937
5938         let mut msg = msgs::UpdateAddHTLC {
5939                 channel_id: chan.2,
5940                 htlc_id: 0,
5941                 amount_msat: 1000,
5942                 payment_hash: our_payment_hash,
5943                 cltv_expiry: htlc_cltv,
5944                 onion_routing_packet: onion_packet.clone(),
5945         };
5946
5947         for i in 0..super::channel::OUR_MAX_HTLCS {
5948                 msg.htlc_id = i as u64;
5949                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5950         }
5951         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5952         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5953
5954         assert!(nodes[1].node.list_channels().is_empty());
5955         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5956         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5957         check_added_monitors!(nodes[1], 1);
5958 }
5959
5960 #[test]
5961 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5962         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5963         let chanmon_cfgs = create_chanmon_cfgs(2);
5964         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5965         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5966         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5967         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5968         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5969         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5970         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5971         check_added_monitors!(nodes[0], 1);
5972         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5973         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5974         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5975
5976         assert!(nodes[1].node.list_channels().is_empty());
5977         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5978         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5979         check_added_monitors!(nodes[1], 1);
5980 }
5981
5982 #[test]
5983 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5984         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5985         let chanmon_cfgs = create_chanmon_cfgs(2);
5986         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5987         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5988         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5989         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5990         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5991         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5992         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5993         check_added_monitors!(nodes[0], 1);
5994         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5995         updates.update_add_htlcs[0].cltv_expiry = 500000000;
5996         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5997
5998         assert!(nodes[1].node.list_channels().is_empty());
5999         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6000         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6001         check_added_monitors!(nodes[1], 1);
6002 }
6003
6004 #[test]
6005 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6006         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6007         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6008         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6009         let chanmon_cfgs = create_chanmon_cfgs(2);
6010         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6011         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6012         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6013         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6014         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6015         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6016         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6017         check_added_monitors!(nodes[0], 1);
6018         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6019         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6020
6021         //Disconnect and Reconnect
6022         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6023         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6024         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6025         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6026         assert_eq!(reestablish_1.len(), 1);
6027         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6028         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6029         assert_eq!(reestablish_2.len(), 1);
6030         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6031         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6032         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6033         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6034
6035         //Resend HTLC
6036         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6037         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6038         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6039         check_added_monitors!(nodes[1], 1);
6040         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6041
6042         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6043
6044         assert!(nodes[1].node.list_channels().is_empty());
6045         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6046         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
6047         check_added_monitors!(nodes[1], 1);
6048 }
6049
6050 #[test]
6051 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6052         //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.
6053
6054         let chanmon_cfgs = create_chanmon_cfgs(2);
6055         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6056         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6057         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6058         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6059
6060         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6061         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6062         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6063         check_added_monitors!(nodes[0], 1);
6064         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6065         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6066
6067         let update_msg = msgs::UpdateFulfillHTLC{
6068                 channel_id: chan.2,
6069                 htlc_id: 0,
6070                 payment_preimage: our_payment_preimage,
6071         };
6072
6073         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6074
6075         assert!(nodes[0].node.list_channels().is_empty());
6076         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6077         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6078         check_added_monitors!(nodes[0], 1);
6079 }
6080
6081 #[test]
6082 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6083         //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.
6084
6085         let chanmon_cfgs = create_chanmon_cfgs(2);
6086         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6087         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6088         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6089         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6090
6091         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6092         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6093         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6094         check_added_monitors!(nodes[0], 1);
6095         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6096         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6097
6098         let update_msg = msgs::UpdateFailHTLC{
6099                 channel_id: chan.2,
6100                 htlc_id: 0,
6101                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6102         };
6103
6104         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6105
6106         assert!(nodes[0].node.list_channels().is_empty());
6107         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6108         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6109         check_added_monitors!(nodes[0], 1);
6110 }
6111
6112 #[test]
6113 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6114         //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.
6115
6116         let chanmon_cfgs = create_chanmon_cfgs(2);
6117         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6118         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6119         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6120         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6121
6122         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6123         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6124         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6125         check_added_monitors!(nodes[0], 1);
6126         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6127         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6128
6129         let update_msg = msgs::UpdateFailMalformedHTLC{
6130                 channel_id: chan.2,
6131                 htlc_id: 0,
6132                 sha256_of_onion: [1; 32],
6133                 failure_code: 0x8000,
6134         };
6135
6136         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6137
6138         assert!(nodes[0].node.list_channels().is_empty());
6139         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6140         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6141         check_added_monitors!(nodes[0], 1);
6142 }
6143
6144 #[test]
6145 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6146         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6147
6148         let chanmon_cfgs = create_chanmon_cfgs(2);
6149         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6150         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6151         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6152         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6153
6154         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6155
6156         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6157         check_added_monitors!(nodes[1], 1);
6158
6159         let events = nodes[1].node.get_and_clear_pending_msg_events();
6160         assert_eq!(events.len(), 1);
6161         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6162                 match events[0] {
6163                         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, .. } } => {
6164                                 assert!(update_add_htlcs.is_empty());
6165                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6166                                 assert!(update_fail_htlcs.is_empty());
6167                                 assert!(update_fail_malformed_htlcs.is_empty());
6168                                 assert!(update_fee.is_none());
6169                                 update_fulfill_htlcs[0].clone()
6170                         },
6171                         _ => panic!("Unexpected event"),
6172                 }
6173         };
6174
6175         update_fulfill_msg.htlc_id = 1;
6176
6177         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6178
6179         assert!(nodes[0].node.list_channels().is_empty());
6180         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6181         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6182         check_added_monitors!(nodes[0], 1);
6183 }
6184
6185 #[test]
6186 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6187         //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.
6188
6189         let chanmon_cfgs = create_chanmon_cfgs(2);
6190         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6191         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6192         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6193         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6194
6195         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6196
6197         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6198         check_added_monitors!(nodes[1], 1);
6199
6200         let events = nodes[1].node.get_and_clear_pending_msg_events();
6201         assert_eq!(events.len(), 1);
6202         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6203                 match events[0] {
6204                         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, .. } } => {
6205                                 assert!(update_add_htlcs.is_empty());
6206                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6207                                 assert!(update_fail_htlcs.is_empty());
6208                                 assert!(update_fail_malformed_htlcs.is_empty());
6209                                 assert!(update_fee.is_none());
6210                                 update_fulfill_htlcs[0].clone()
6211                         },
6212                         _ => panic!("Unexpected event"),
6213                 }
6214         };
6215
6216         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6217
6218         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6219
6220         assert!(nodes[0].node.list_channels().is_empty());
6221         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6222         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
6223         check_added_monitors!(nodes[0], 1);
6224 }
6225
6226 #[test]
6227 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6228         //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.
6229
6230         let chanmon_cfgs = create_chanmon_cfgs(2);
6231         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6232         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6233         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6234         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6235         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6236         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6237         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6238         check_added_monitors!(nodes[0], 1);
6239
6240         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6241         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6242
6243         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6244         check_added_monitors!(nodes[1], 0);
6245         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6246
6247         let events = nodes[1].node.get_and_clear_pending_msg_events();
6248
6249         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6250                 match events[0] {
6251                         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, .. } } => {
6252                                 assert!(update_add_htlcs.is_empty());
6253                                 assert!(update_fulfill_htlcs.is_empty());
6254                                 assert!(update_fail_htlcs.is_empty());
6255                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6256                                 assert!(update_fee.is_none());
6257                                 update_fail_malformed_htlcs[0].clone()
6258                         },
6259                         _ => panic!("Unexpected event"),
6260                 }
6261         };
6262         update_msg.failure_code &= !0x8000;
6263         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6264
6265         assert!(nodes[0].node.list_channels().is_empty());
6266         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6267         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6268         check_added_monitors!(nodes[0], 1);
6269 }
6270
6271 #[test]
6272 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6273         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6274         //    * 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.
6275
6276         let chanmon_cfgs = create_chanmon_cfgs(3);
6277         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6278         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6279         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6280         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6281         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6282
6283         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
6284         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6285
6286         //First hop
6287         let mut payment_event = {
6288                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6289                 check_added_monitors!(nodes[0], 1);
6290                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6291                 assert_eq!(events.len(), 1);
6292                 SendEvent::from_event(events.remove(0))
6293         };
6294         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6295         check_added_monitors!(nodes[1], 0);
6296         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6297         expect_pending_htlcs_forwardable!(nodes[1]);
6298         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6299         assert_eq!(events_2.len(), 1);
6300         check_added_monitors!(nodes[1], 1);
6301         payment_event = SendEvent::from_event(events_2.remove(0));
6302         assert_eq!(payment_event.msgs.len(), 1);
6303
6304         //Second Hop
6305         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6306         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6307         check_added_monitors!(nodes[2], 0);
6308         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6309
6310         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6311         assert_eq!(events_3.len(), 1);
6312         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6313                 match events_3[0] {
6314                         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 } } => {
6315                                 assert!(update_add_htlcs.is_empty());
6316                                 assert!(update_fulfill_htlcs.is_empty());
6317                                 assert!(update_fail_htlcs.is_empty());
6318                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6319                                 assert!(update_fee.is_none());
6320                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6321                         },
6322                         _ => panic!("Unexpected event"),
6323                 }
6324         };
6325
6326         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6327
6328         check_added_monitors!(nodes[1], 0);
6329         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6330         expect_pending_htlcs_forwardable!(nodes[1]);
6331         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6332         assert_eq!(events_4.len(), 1);
6333
6334         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6335         match events_4[0] {
6336                 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, .. } } => {
6337                         assert!(update_add_htlcs.is_empty());
6338                         assert!(update_fulfill_htlcs.is_empty());
6339                         assert_eq!(update_fail_htlcs.len(), 1);
6340                         assert!(update_fail_malformed_htlcs.is_empty());
6341                         assert!(update_fee.is_none());
6342                 },
6343                 _ => panic!("Unexpected event"),
6344         };
6345
6346         check_added_monitors!(nodes[1], 1);
6347 }
6348
6349 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6350         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6351         // 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
6352         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6353
6354         let chanmon_cfgs = create_chanmon_cfgs(2);
6355         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6356         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6357         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6358         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6359
6360         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6361
6362         // We route 2 dust-HTLCs between A and B
6363         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6364         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6365         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6366
6367         // Cache one local commitment tx as previous
6368         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6369
6370         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6371         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
6372         check_added_monitors!(nodes[1], 0);
6373         expect_pending_htlcs_forwardable!(nodes[1]);
6374         check_added_monitors!(nodes[1], 1);
6375
6376         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6377         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6378         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6379         check_added_monitors!(nodes[0], 1);
6380
6381         // Cache one local commitment tx as lastest
6382         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6383
6384         let events = nodes[0].node.get_and_clear_pending_msg_events();
6385         match events[0] {
6386                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6387                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6388                 },
6389                 _ => panic!("Unexpected event"),
6390         }
6391         match events[1] {
6392                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6393                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6394                 },
6395                 _ => panic!("Unexpected event"),
6396         }
6397
6398         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6399         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6400         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6401
6402         if announce_latest {
6403                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6404         } else {
6405                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6406         }
6407
6408         check_closed_broadcast!(nodes[0], false);
6409         check_added_monitors!(nodes[0], 1);
6410
6411         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6412         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
6413         let events = nodes[0].node.get_and_clear_pending_events();
6414         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6415         assert_eq!(events.len(), 2);
6416         let mut first_failed = false;
6417         for event in events {
6418                 match event {
6419                         Event::PaymentFailed { payment_hash, .. } => {
6420                                 if payment_hash == payment_hash_1 {
6421                                         assert!(!first_failed);
6422                                         first_failed = true;
6423                                 } else {
6424                                         assert_eq!(payment_hash, payment_hash_2);
6425                                 }
6426                         }
6427                         _ => panic!("Unexpected event"),
6428                 }
6429         }
6430 }
6431
6432 #[test]
6433 fn test_failure_delay_dust_htlc_local_commitment() {
6434         do_test_failure_delay_dust_htlc_local_commitment(true);
6435         do_test_failure_delay_dust_htlc_local_commitment(false);
6436 }
6437
6438 #[test]
6439 fn test_no_failure_dust_htlc_local_commitment() {
6440         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6441         // prone to error, we test here that a dummy transaction don't fail them.
6442
6443         let chanmon_cfgs = create_chanmon_cfgs(2);
6444         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6445         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6446         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6447         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6448
6449         // Rebalance a bit
6450         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6451
6452         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6453         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6454
6455         // We route 2 dust-HTLCs between A and B
6456         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6457         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6458
6459         // Build a dummy invalid transaction trying to spend a commitment tx
6460         let input = TxIn {
6461                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6462                 script_sig: Script::new(),
6463                 sequence: 0,
6464                 witness: Vec::new(),
6465         };
6466
6467         let outp = TxOut {
6468                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6469                 value: 10000,
6470         };
6471
6472         let dummy_tx = Transaction {
6473                 version: 2,
6474                 lock_time: 0,
6475                 input: vec![input],
6476                 output: vec![outp]
6477         };
6478
6479         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6480         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6481         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6482         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6483         // We broadcast a few more block to check everything is all right
6484         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
6485         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6486         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6487
6488         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6489         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6490 }
6491
6492 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6493         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6494         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6495         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6496         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6497         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6498         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6499
6500         let chanmon_cfgs = create_chanmon_cfgs(3);
6501         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6502         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6503         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6504         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6505
6506         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6507
6508         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6509         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6510
6511         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6512         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
6513
6514         // We revoked bs_commitment_tx
6515         if revoked {
6516                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6517                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6518         }
6519
6520         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6521         let mut timeout_tx = Vec::new();
6522         if local {
6523                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6524                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6525                 check_closed_broadcast!(nodes[0], false);
6526                 check_added_monitors!(nodes[0], 1);
6527                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6528                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6529                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6530                 let events = nodes[0].node.get_and_clear_pending_events();
6531                 assert_eq!(events.len(), 1);
6532                 match events[0] {
6533                         Event::PaymentFailed { payment_hash, .. } => {
6534                                 assert_eq!(payment_hash, dust_hash);
6535                         },
6536                         _ => panic!("Unexpected event"),
6537                 }
6538                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6539                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6540                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6541                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6542                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6543                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6544                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6545                 let events = nodes[0].node.get_and_clear_pending_events();
6546                 assert_eq!(events.len(), 1);
6547                 match events[0] {
6548                         Event::PaymentFailed { payment_hash, .. } => {
6549                                 assert_eq!(payment_hash, non_dust_hash);
6550                         },
6551                         _ => panic!("Unexpected event"),
6552                 }
6553         } else {
6554                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6555                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6556                 check_closed_broadcast!(nodes[0], false);
6557                 check_added_monitors!(nodes[0], 1);
6558                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6559                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6560                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6561                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6562                 if !revoked {
6563                         let events = nodes[0].node.get_and_clear_pending_events();
6564                         assert_eq!(events.len(), 1);
6565                         match events[0] {
6566                                 Event::PaymentFailed { payment_hash, .. } => {
6567                                         assert_eq!(payment_hash, dust_hash);
6568                                 },
6569                                 _ => panic!("Unexpected event"),
6570                         }
6571                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6572                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6573                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6574                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6575                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6576                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6577                         let events = nodes[0].node.get_and_clear_pending_events();
6578                         assert_eq!(events.len(), 1);
6579                         match events[0] {
6580                                 Event::PaymentFailed { payment_hash, .. } => {
6581                                         assert_eq!(payment_hash, non_dust_hash);
6582                                 },
6583                                 _ => panic!("Unexpected event"),
6584                         }
6585                 } else {
6586                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6587                         // commitment tx
6588                         let events = nodes[0].node.get_and_clear_pending_events();
6589                         assert_eq!(events.len(), 2);
6590                         let first;
6591                         match events[0] {
6592                                 Event::PaymentFailed { payment_hash, .. } => {
6593                                         if payment_hash == dust_hash { first = true; }
6594                                         else { first = false; }
6595                                 },
6596                                 _ => panic!("Unexpected event"),
6597                         }
6598                         match events[1] {
6599                                 Event::PaymentFailed { payment_hash, .. } => {
6600                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6601                                         else { assert_eq!(payment_hash, dust_hash); }
6602                                 },
6603                                 _ => panic!("Unexpected event"),
6604                         }
6605                 }
6606         }
6607 }
6608
6609 #[test]
6610 fn test_sweep_outbound_htlc_failure_update() {
6611         do_test_sweep_outbound_htlc_failure_update(false, true);
6612         do_test_sweep_outbound_htlc_failure_update(false, false);
6613         do_test_sweep_outbound_htlc_failure_update(true, false);
6614 }
6615
6616 #[test]
6617 fn test_upfront_shutdown_script() {
6618         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6619         // enforce it at shutdown message
6620
6621         let mut config = UserConfig::default();
6622         config.channel_options.announced_channel = true;
6623         config.peer_channel_config_limits.force_announced_channel_preference = false;
6624         config.channel_options.commit_upfront_shutdown_pubkey = false;
6625         let user_cfgs = [None, Some(config), None];
6626         let chanmon_cfgs = create_chanmon_cfgs(3);
6627         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6628         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6629         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6630
6631         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6632         let flags = InitFeatures::supported();
6633         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6634         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6635         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6636         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6637         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6638         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6639         assert_eq!(check_closed_broadcast!(nodes[2], true).unwrap().data, "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6640         check_added_monitors!(nodes[2], 1);
6641
6642         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6643         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6644         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6645         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6646         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6647         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6648         let events = nodes[2].node.get_and_clear_pending_msg_events();
6649         assert_eq!(events.len(), 1);
6650         match events[0] {
6651                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6652                 _ => panic!("Unexpected event"),
6653         }
6654
6655         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6656         let mut flags_no = InitFeatures::supported();
6657         flags_no.unset_upfront_shutdown_script();
6658         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6659         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6660         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6661         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6662         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6663         let events = nodes[1].node.get_and_clear_pending_msg_events();
6664         assert_eq!(events.len(), 1);
6665         match events[0] {
6666                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6667                 _ => panic!("Unexpected event"),
6668         }
6669
6670         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6671         // channel smoothly, opt-out is from channel initiator here
6672         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6673         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6674         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6675         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6676         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6677         let events = nodes[0].node.get_and_clear_pending_msg_events();
6678         assert_eq!(events.len(), 1);
6679         match events[0] {
6680                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6681                 _ => panic!("Unexpected event"),
6682         }
6683
6684         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6685         //// channel smoothly
6686         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6687         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6688         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6689         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6690         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6691         let events = nodes[0].node.get_and_clear_pending_msg_events();
6692         assert_eq!(events.len(), 2);
6693         match events[0] {
6694                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6695                 _ => panic!("Unexpected event"),
6696         }
6697         match events[1] {
6698                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6699                 _ => panic!("Unexpected event"),
6700         }
6701 }
6702
6703 #[test]
6704 fn test_user_configurable_csv_delay() {
6705         // We test our channel constructors yield errors when we pass them absurd csv delay
6706
6707         let mut low_our_to_self_config = UserConfig::default();
6708         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6709         let mut high_their_to_self_config = UserConfig::default();
6710         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6711         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6712         let chanmon_cfgs = create_chanmon_cfgs(2);
6713         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6714         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6715         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6716
6717         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6718         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())));
6719         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) {
6720                 match error {
6721                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6722                         _ => panic!("Unexpected event"),
6723                 }
6724         } else { assert!(false) }
6725
6726         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6727         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6728         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6729         open_channel.to_self_delay = 200;
6730         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) {
6731                 match error {
6732                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6733                         _ => panic!("Unexpected event"),
6734                 }
6735         } else { assert!(false); }
6736
6737         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6738         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6739         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()));
6740         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6741         accept_channel.to_self_delay = 200;
6742         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6743         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6744                 match action {
6745                         &ErrorAction::SendErrorMessage { ref msg } => {
6746                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6747                         },
6748                         _ => { assert!(false); }
6749                 }
6750         } else { assert!(false); }
6751
6752         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6753         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6754         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6755         open_channel.to_self_delay = 200;
6756         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) {
6757                 match error {
6758                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6759                         _ => panic!("Unexpected event"),
6760                 }
6761         } else { assert!(false); }
6762 }
6763
6764 #[test]
6765 fn test_data_loss_protect() {
6766         // We want to be sure that :
6767         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6768         // * we close channel in case of detecting other being fallen behind
6769         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6770         let keys_manager;
6771         let fee_estimator;
6772         let tx_broadcaster;
6773         let monitor;
6774         let node_state_0;
6775         let chanmon_cfgs = create_chanmon_cfgs(2);
6776         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6777         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6778         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6779
6780         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6781
6782         // Cache node A state before any channel update
6783         let previous_node_state = nodes[0].node.encode();
6784         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6785         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6786
6787         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6788         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6789
6790         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6791         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6792
6793         // Restore node A from previous state
6794         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6795         let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6796         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6797         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
6798         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
6799         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger));
6800         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &tx_broadcaster, logger.clone(), &fee_estimator);
6801         node_state_0 = {
6802                 let mut channel_monitors = HashMap::new();
6803                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6804                 <(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 {
6805                         keys_manager: &keys_manager,
6806                         fee_estimator: &fee_estimator,
6807                         monitor: &monitor,
6808                         logger: Arc::clone(&logger),
6809                         tx_broadcaster: &tx_broadcaster,
6810                         default_config: UserConfig::default(),
6811                         channel_monitors: &mut channel_monitors,
6812                 }).unwrap().1
6813         };
6814         nodes[0].node = &node_state_0;
6815         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
6816         nodes[0].chan_monitor = &monitor;
6817         nodes[0].chain_monitor = chain_monitor;
6818
6819         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6820         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6821         nodes[0].block_notifier.register_listener(nodes[0].node);
6822
6823         check_added_monitors!(nodes[0], 1);
6824
6825         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6826         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6827
6828         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6829
6830         // Check we update monitor following learning of per_commitment_point from B
6831         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6832         check_added_monitors!(nodes[0], 2);
6833
6834         {
6835                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6836                 assert_eq!(node_txn.len(), 0);
6837         }
6838
6839         let mut reestablish_1 = Vec::with_capacity(1);
6840         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6841                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6842                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6843                         reestablish_1.push(msg.clone());
6844                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6845                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6846                         match action {
6847                                 &ErrorAction::SendErrorMessage { ref msg } => {
6848                                         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");
6849                                 },
6850                                 _ => panic!("Unexpected event!"),
6851                         }
6852                 } else {
6853                         panic!("Unexpected event")
6854                 }
6855         }
6856
6857         // Check we close channel detecting A is fallen-behind
6858         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6859         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
6860         check_added_monitors!(nodes[1], 1);
6861
6862
6863         // Check A is able to claim to_remote output
6864         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6865         assert_eq!(node_txn.len(), 1);
6866         check_spends!(node_txn[0], chan.3);
6867         assert_eq!(node_txn[0].output.len(), 2);
6868         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6869         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
6870         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
6871         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6872         assert_eq!(spend_txn.len(), 1);
6873         check_spends!(spend_txn[0], node_txn[0]);
6874 }
6875
6876 #[test]
6877 fn test_check_htlc_underpaying() {
6878         // Send payment through A -> B but A is maliciously
6879         // sending a probe payment (i.e less than expected value0
6880         // to B, B should refuse payment.
6881
6882         let chanmon_cfgs = create_chanmon_cfgs(2);
6883         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6884         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6885         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6886
6887         // Create some initial channels
6888         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6889
6890         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6891
6892         // Node 3 is expecting payment of 100_000 but receive 10_000,
6893         // fail htlc like we didn't know the preimage.
6894         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
6895         nodes[1].node.process_pending_htlc_forwards();
6896
6897         let events = nodes[1].node.get_and_clear_pending_msg_events();
6898         assert_eq!(events.len(), 1);
6899         let (update_fail_htlc, commitment_signed) = match events[0] {
6900                 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 } } => {
6901                         assert!(update_add_htlcs.is_empty());
6902                         assert!(update_fulfill_htlcs.is_empty());
6903                         assert_eq!(update_fail_htlcs.len(), 1);
6904                         assert!(update_fail_malformed_htlcs.is_empty());
6905                         assert!(update_fee.is_none());
6906                         (update_fail_htlcs[0].clone(), commitment_signed)
6907                 },
6908                 _ => panic!("Unexpected event"),
6909         };
6910         check_added_monitors!(nodes[1], 1);
6911
6912         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6913         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6914
6915         let events = nodes[0].node.get_and_clear_pending_events();
6916         assert_eq!(events.len(), 1);
6917         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code, ref error_data } = &events[0] {
6918                 assert_eq!(*rejected_by_dest, true);
6919                 assert_eq!(error_code.unwrap(), 0x4000|15);
6920                 // 10_000 msat as u64, followed by a height of 99 as u32
6921                 assert_eq!(&error_data.as_ref().unwrap()[..], &[
6922                         ((10_000u64 >> 7*8) & 0xff) as u8,
6923                         ((10_000u64 >> 6*8) & 0xff) as u8,
6924                         ((10_000u64 >> 5*8) & 0xff) as u8,
6925                         ((10_000u64 >> 4*8) & 0xff) as u8,
6926                         ((10_000u64 >> 3*8) & 0xff) as u8,
6927                         ((10_000u64 >> 2*8) & 0xff) as u8,
6928                         ((10_000u64 >> 1*8) & 0xff) as u8,
6929                         ((10_000u64 >> 0*8) & 0xff) as u8,
6930                         0, 0, 0, 99]);
6931         } else {
6932                 panic!("Unexpected event");
6933         }
6934         nodes[1].node.get_and_clear_pending_events();
6935 }
6936
6937 #[test]
6938 fn test_announce_disable_channels() {
6939         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6940         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6941
6942         let chanmon_cfgs = create_chanmon_cfgs(2);
6943         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6944         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6945         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6946
6947         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6948         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6949         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6950
6951         // Disconnect peers
6952         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6953         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6954
6955         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6956         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6957         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6958         assert_eq!(msg_events.len(), 3);
6959         for e in msg_events {
6960                 match e {
6961                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6962                                 let short_id = msg.contents.short_channel_id;
6963                                 // Check generated channel_update match list in PendingChannelUpdate
6964                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6965                                         panic!("Generated ChannelUpdate for wrong chan!");
6966                                 }
6967                         },
6968                         _ => panic!("Unexpected event"),
6969                 }
6970         }
6971         // Reconnect peers
6972         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6973         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6974         assert_eq!(reestablish_1.len(), 3);
6975         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6976         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6977         assert_eq!(reestablish_2.len(), 3);
6978
6979         // Reestablish chan_1
6980         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6981         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6982         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6983         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6984         // Reestablish chan_2
6985         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6986         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6987         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6988         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6989         // Reestablish chan_3
6990         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6991         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6992         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6993         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6994
6995         nodes[0].node.timer_chan_freshness_every_min();
6996         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6997 }
6998
6999 #[test]
7000 fn test_bump_penalty_txn_on_revoked_commitment() {
7001         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7002         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7003
7004         let chanmon_cfgs = create_chanmon_cfgs(2);
7005         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7006         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7007         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7008
7009         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7010         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7011         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
7012         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7013
7014         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7015         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7016         assert_eq!(revoked_txn[0].output.len(), 4);
7017         assert_eq!(revoked_txn[0].input.len(), 1);
7018         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7019         let revoked_txid = revoked_txn[0].txid();
7020
7021         let mut penalty_sum = 0;
7022         for outp in revoked_txn[0].output.iter() {
7023                 if outp.script_pubkey.is_v0_p2wsh() {
7024                         penalty_sum += outp.value;
7025                 }
7026         }
7027
7028         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7029         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
7030
7031         // Actually revoke tx by claiming a HTLC
7032         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7033         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7034         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7035         check_added_monitors!(nodes[1], 1);
7036
7037         // One or more justice tx should have been broadcast, check it
7038         let penalty_1;
7039         let feerate_1;
7040         {
7041                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7042                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7043                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7044                 assert_eq!(node_txn[0].output.len(), 1);
7045                 check_spends!(node_txn[0], revoked_txn[0]);
7046                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7047                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7048                 penalty_1 = node_txn[0].txid();
7049                 node_txn.clear();
7050         };
7051
7052         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7053         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
7054         let mut penalty_2 = penalty_1;
7055         let mut feerate_2 = 0;
7056         {
7057                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7058                 assert_eq!(node_txn.len(), 1);
7059                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7060                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7061                         assert_eq!(node_txn[0].output.len(), 1);
7062                         check_spends!(node_txn[0], revoked_txn[0]);
7063                         penalty_2 = node_txn[0].txid();
7064                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7065                         assert_ne!(penalty_2, penalty_1);
7066                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7067                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7068                         // Verify 25% bump heuristic
7069                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7070                         node_txn.clear();
7071                 }
7072         }
7073         assert_ne!(feerate_2, 0);
7074
7075         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7076         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
7077         let penalty_3;
7078         let mut feerate_3 = 0;
7079         {
7080                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7081                 assert_eq!(node_txn.len(), 1);
7082                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7083                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7084                         assert_eq!(node_txn[0].output.len(), 1);
7085                         check_spends!(node_txn[0], revoked_txn[0]);
7086                         penalty_3 = node_txn[0].txid();
7087                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7088                         assert_ne!(penalty_3, penalty_2);
7089                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7090                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7091                         // Verify 25% bump heuristic
7092                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7093                         node_txn.clear();
7094                 }
7095         }
7096         assert_ne!(feerate_3, 0);
7097
7098         nodes[1].node.get_and_clear_pending_events();
7099         nodes[1].node.get_and_clear_pending_msg_events();
7100 }
7101
7102 #[test]
7103 fn test_bump_penalty_txn_on_revoked_htlcs() {
7104         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7105         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7106
7107         let chanmon_cfgs = create_chanmon_cfgs(2);
7108         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7109         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7110         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7111
7112         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7113         // Lock HTLC in both directions
7114         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7115         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7116
7117         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7118         assert_eq!(revoked_local_txn[0].input.len(), 1);
7119         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7120
7121         // Revoke local commitment tx
7122         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7123
7124         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7125         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7126         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7127         check_closed_broadcast!(nodes[1], false);
7128         check_added_monitors!(nodes[1], 1);
7129
7130         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7131         assert_eq!(revoked_htlc_txn.len(), 4);
7132         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7133                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7134                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7135                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7136                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7137                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7138         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7139                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7140                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7141                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7142                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7143                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7144         }
7145
7146         // Broadcast set of revoked txn on A
7147         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
7148         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7149         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);
7150         let first;
7151         let feerate_1;
7152         let penalty_txn;
7153         {
7154                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7155                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7156                 // Verify claim tx are spending revoked HTLC txn
7157                 assert_eq!(node_txn[4].input.len(), 2);
7158                 assert_eq!(node_txn[4].output.len(), 1);
7159                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7160                 first = node_txn[4].txid();
7161                 // Store both feerates for later comparison
7162                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7163                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7164                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7165                 node_txn.clear();
7166         }
7167
7168         // Connect three more block to see if bumped penalty are issued for HTLC txn
7169         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7170         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7171         {
7172                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7173                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7174
7175                 check_spends!(node_txn[0], revoked_local_txn[0]);
7176                 check_spends!(node_txn[1], revoked_local_txn[0]);
7177
7178                 node_txn.clear();
7179         };
7180
7181         // Few more blocks to confirm penalty txn
7182         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
7183         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7184         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
7185         let node_txn = {
7186                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7187                 assert_eq!(node_txn.len(), 1);
7188
7189                 assert_eq!(node_txn[0].input.len(), 2);
7190                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7191                 // Verify bumped tx is different and 25% bump heuristic
7192                 assert_ne!(first, node_txn[0].txid());
7193                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7194                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7195                 assert!(feerate_2 * 100 > feerate_1 * 125);
7196                 let txn = vec![node_txn[0].clone()];
7197                 node_txn.clear();
7198                 txn
7199         };
7200         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7201         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7202         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
7203         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
7204         {
7205                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7206                 // We verify than no new transaction has been broadcast because previously
7207                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7208                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7209                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7210                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7211                 // up bumped justice generation.
7212                 assert_eq!(node_txn.len(), 0);
7213                 node_txn.clear();
7214         }
7215         check_closed_broadcast!(nodes[0], false);
7216         check_added_monitors!(nodes[0], 1);
7217 }
7218
7219 #[test]
7220 fn test_bump_penalty_txn_on_remote_commitment() {
7221         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7222         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7223
7224         // Create 2 HTLCs
7225         // Provide preimage for one
7226         // Check aggregation
7227
7228         let chanmon_cfgs = create_chanmon_cfgs(2);
7229         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7230         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7231         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7232
7233         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7234         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7235         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7236
7237         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7238         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7239         assert_eq!(remote_txn[0].output.len(), 4);
7240         assert_eq!(remote_txn[0].input.len(), 1);
7241         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7242
7243         // Claim a HTLC without revocation (provide B monitor with preimage)
7244         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7245         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7246         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7247         check_added_monitors!(nodes[1], 2);
7248
7249         // One or more claim tx should have been broadcast, check it
7250         let timeout;
7251         let preimage;
7252         let feerate_timeout;
7253         let feerate_preimage;
7254         {
7255                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7256                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7257                 assert_eq!(node_txn[0].input.len(), 1);
7258                 assert_eq!(node_txn[1].input.len(), 1);
7259                 check_spends!(node_txn[0], remote_txn[0]);
7260                 check_spends!(node_txn[1], remote_txn[0]);
7261                 check_spends!(node_txn[2], chan.3);
7262                 check_spends!(node_txn[3], node_txn[2]);
7263                 check_spends!(node_txn[4], node_txn[2]);
7264                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7265                         timeout = node_txn[0].txid();
7266                         let index = node_txn[0].input[0].previous_output.vout;
7267                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7268                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7269
7270                         preimage = node_txn[1].txid();
7271                         let index = node_txn[1].input[0].previous_output.vout;
7272                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7273                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7274                 } else {
7275                         timeout = node_txn[1].txid();
7276                         let index = node_txn[1].input[0].previous_output.vout;
7277                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7278                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7279
7280                         preimage = node_txn[0].txid();
7281                         let index = node_txn[0].input[0].previous_output.vout;
7282                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7283                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7284                 }
7285                 node_txn.clear();
7286         };
7287         assert_ne!(feerate_timeout, 0);
7288         assert_ne!(feerate_preimage, 0);
7289
7290         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7291         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
7292         {
7293                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7294                 assert_eq!(node_txn.len(), 2);
7295                 assert_eq!(node_txn[0].input.len(), 1);
7296                 assert_eq!(node_txn[1].input.len(), 1);
7297                 check_spends!(node_txn[0], remote_txn[0]);
7298                 check_spends!(node_txn[1], remote_txn[0]);
7299                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7300                         let index = node_txn[0].input[0].previous_output.vout;
7301                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7302                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7303                         assert!(new_feerate * 100 > feerate_timeout * 125);
7304                         assert_ne!(timeout, node_txn[0].txid());
7305
7306                         let index = node_txn[1].input[0].previous_output.vout;
7307                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7308                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7309                         assert!(new_feerate * 100 > feerate_preimage * 125);
7310                         assert_ne!(preimage, node_txn[1].txid());
7311                 } else {
7312                         let index = node_txn[1].input[0].previous_output.vout;
7313                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7314                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7315                         assert!(new_feerate * 100 > feerate_timeout * 125);
7316                         assert_ne!(timeout, node_txn[1].txid());
7317
7318                         let index = node_txn[0].input[0].previous_output.vout;
7319                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7320                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7321                         assert!(new_feerate * 100 > feerate_preimage * 125);
7322                         assert_ne!(preimage, node_txn[0].txid());
7323                 }
7324                 node_txn.clear();
7325         }
7326
7327         nodes[1].node.get_and_clear_pending_events();
7328         nodes[1].node.get_and_clear_pending_msg_events();
7329 }
7330
7331 #[test]
7332 fn test_set_outpoints_partial_claiming() {
7333         // - remote party claim tx, new bump tx
7334         // - disconnect remote claiming tx, new bump
7335         // - disconnect tx, see no tx anymore
7336         let chanmon_cfgs = create_chanmon_cfgs(2);
7337         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7338         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7339         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7340
7341         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7342         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7343         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7344
7345         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7346         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
7347         assert_eq!(remote_txn.len(), 3);
7348         assert_eq!(remote_txn[0].output.len(), 4);
7349         assert_eq!(remote_txn[0].input.len(), 1);
7350         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7351         check_spends!(remote_txn[1], remote_txn[0]);
7352         check_spends!(remote_txn[2], remote_txn[0]);
7353
7354         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7355         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7356         // Provide node A with both preimage
7357         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
7358         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
7359         check_added_monitors!(nodes[0], 2);
7360         nodes[0].node.get_and_clear_pending_events();
7361         nodes[0].node.get_and_clear_pending_msg_events();
7362
7363         // Connect blocks on node A commitment transaction
7364         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7365         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7366         check_closed_broadcast!(nodes[0], false);
7367         check_added_monitors!(nodes[0], 1);
7368         // Verify node A broadcast tx claiming both HTLCs
7369         {
7370                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7371                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7372                 assert_eq!(node_txn.len(), 4);
7373                 check_spends!(node_txn[0], remote_txn[0]);
7374                 check_spends!(node_txn[1], chan.3);
7375                 check_spends!(node_txn[2], node_txn[1]);
7376                 check_spends!(node_txn[3], node_txn[1]);
7377                 assert_eq!(node_txn[0].input.len(), 2);
7378                 node_txn.clear();
7379         }
7380
7381         // Connect blocks on node B
7382         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7383         check_closed_broadcast!(nodes[1], false);
7384         check_added_monitors!(nodes[1], 1);
7385         // Verify node B broadcast 2 HTLC-timeout txn
7386         let partial_claim_tx = {
7387                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7388                 assert_eq!(node_txn.len(), 3);
7389                 check_spends!(node_txn[1], node_txn[0]);
7390                 check_spends!(node_txn[2], node_txn[0]);
7391                 assert_eq!(node_txn[1].input.len(), 1);
7392                 assert_eq!(node_txn[2].input.len(), 1);
7393                 node_txn[1].clone()
7394         };
7395
7396         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7397         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7398         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7399         {
7400                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7401                 assert_eq!(node_txn.len(), 1);
7402                 check_spends!(node_txn[0], remote_txn[0]);
7403                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7404                 node_txn.clear();
7405         }
7406         nodes[0].node.get_and_clear_pending_msg_events();
7407
7408         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7409         nodes[0].block_notifier.block_disconnected(&header, 102);
7410         {
7411                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7412                 assert_eq!(node_txn.len(), 1);
7413                 check_spends!(node_txn[0], remote_txn[0]);
7414                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7415                 node_txn.clear();
7416         }
7417
7418         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7419         nodes[0].block_notifier.block_disconnected(&header, 101);
7420         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7421         {
7422                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7423                 assert_eq!(node_txn.len(), 0);
7424                 node_txn.clear();
7425         }
7426 }
7427
7428 #[test]
7429 fn test_counterparty_raa_skip_no_crash() {
7430         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7431         // commitment transaction, we would have happily carried on and provided them the next
7432         // commitment transaction based on one RAA forward. This would probably eventually have led to
7433         // channel closure, but it would not have resulted in funds loss. Still, our
7434         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7435         // check simply that the channel is closed in response to such an RAA, but don't check whether
7436         // we decide to punish our counterparty for revoking their funds (as we don't currently
7437         // implement that).
7438         let chanmon_cfgs = create_chanmon_cfgs(2);
7439         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7440         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7441         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7442         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7443
7444         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7445         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7446         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7447                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7448         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7449
7450         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7451                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7452         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7453         check_added_monitors!(nodes[1], 1);
7454 }
7455
7456 #[test]
7457 fn test_bump_txn_sanitize_tracking_maps() {
7458         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7459         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7460
7461         let chanmon_cfgs = create_chanmon_cfgs(2);
7462         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7463         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7464         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7465
7466         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7467         // Lock HTLC in both directions
7468         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7469         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7470
7471         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7472         assert_eq!(revoked_local_txn[0].input.len(), 1);
7473         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7474
7475         // Revoke local commitment tx
7476         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7477
7478         // Broadcast set of revoked txn on A
7479         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7480         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7481         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7482         check_closed_broadcast!(nodes[0], false);
7483         check_added_monitors!(nodes[0], 1);
7484         let penalty_txn = {
7485                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7486                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7487                 check_spends!(node_txn[0], revoked_local_txn[0]);
7488                 check_spends!(node_txn[1], revoked_local_txn[0]);
7489                 check_spends!(node_txn[2], revoked_local_txn[0]);
7490                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7491                 node_txn.clear();
7492                 penalty_txn
7493         };
7494         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7495         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7496         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7497         {
7498                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7499                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7500                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
7501                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
7502                 }
7503         }
7504 }
7505
7506 #[test]
7507 fn test_override_channel_config() {
7508         let chanmon_cfgs = create_chanmon_cfgs(2);
7509         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7510         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7511         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7512
7513         // Node0 initiates a channel to node1 using the override config.
7514         let mut override_config = UserConfig::default();
7515         override_config.own_channel_config.our_to_self_delay = 200;
7516
7517         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7518
7519         // Assert the channel created by node0 is using the override config.
7520         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7521         assert_eq!(res.channel_flags, 0);
7522         assert_eq!(res.to_self_delay, 200);
7523 }
7524
7525 #[test]
7526 fn test_override_0msat_htlc_minimum() {
7527         let mut zero_config = UserConfig::default();
7528         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
7529         let chanmon_cfgs = create_chanmon_cfgs(2);
7530         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7531         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7532         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7533
7534         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7535         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7536         assert_eq!(res.htlc_minimum_msat, 1);
7537
7538         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &res);
7539         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7540         assert_eq!(res.htlc_minimum_msat, 1);
7541 }
7542
7543 #[test]
7544 fn test_simple_payment_secret() {
7545         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
7546         // features, however.
7547         let chanmon_cfgs = create_chanmon_cfgs(3);
7548         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7549         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7550         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7551
7552         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
7553         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
7554
7555         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7556         let payment_secret = PaymentSecret([0xdb; 32]);
7557         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7558         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
7559         // Claiming with all the correct values but the wrong secret should result in nothing...
7560         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
7561         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
7562         // ...but with the right secret we should be able to claim all the way back
7563         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
7564 }
7565
7566 #[test]
7567 fn test_simple_mpp() {
7568         // Simple test of sending a multi-path payment.
7569         let chanmon_cfgs = create_chanmon_cfgs(4);
7570         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7571         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7572         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7573
7574         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7575         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7576         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7577         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7578
7579         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7580         let payment_secret = PaymentSecret([0xdb; 32]);
7581         let mut route = nodes[0].router.get_route(&nodes[3].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7582         let path = route.paths[0].clone();
7583         route.paths.push(path);
7584         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7585         route.paths[0][0].short_channel_id = chan_1_id;
7586         route.paths[0][1].short_channel_id = chan_3_id;
7587         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7588         route.paths[1][0].short_channel_id = chan_2_id;
7589         route.paths[1][1].short_channel_id = chan_4_id;
7590         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
7591         // Claiming with all the correct values but the wrong secret should result in nothing...
7592         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
7593         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
7594         // ...but with the right secret we should be able to claim all the way back
7595         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
7596 }
7597
7598 #[test]
7599 fn test_update_err_monitor_lockdown() {
7600         // Our monitor will lock update of local commitment transaction if a broadcastion condition
7601         // has been fulfilled (either force-close from Channel or block height requiring a HTLC-
7602         // timeout). Trying to update monitor after lockdown should return a ChannelMonitorUpdateErr.
7603         //
7604         // This scenario may happen in a watchtower setup, where watchtower process a block height
7605         // triggering a timeout while a slow-block-processing ChannelManager receives a local signed
7606         // commitment at same time.
7607
7608         let chanmon_cfgs = create_chanmon_cfgs(2);
7609         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7610         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7611         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7612
7613         // Create some initial channel
7614         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
7615         let outpoint = OutPoint { txid: chan_1.3.txid(), index: 0 };
7616
7617         // Rebalance the network to generate htlc in the two directions
7618         send_payment(&nodes[0], &vec!(&nodes[1])[..], 10_000_000, 10_000_000);
7619
7620         // Route a HTLC from node 0 to node 1 (but don't settle)
7621         let preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7622
7623         // Copy SimpleManyChannelMonitor to simulate a watchtower and update block height of node 0 until its ChannelMonitor timeout HTLC onchain
7624         let logger = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
7625         let watchtower = {
7626                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7627                 let monitor = monitors.get(&outpoint).unwrap();
7628                 let mut w = test_utils::TestVecWriter(Vec::new());
7629                 monitor.write_for_disk(&mut w).unwrap();
7630                 let new_monitor = <(Sha256dHash, channelmonitor::ChannelMonitor<EnforcingChannelKeys>)>::read(
7631                                 &mut ::std::io::Cursor::new(&w.0), Arc::new(test_utils::TestLogger::new())).unwrap().1;
7632                 assert!(new_monitor == *monitor);
7633                 let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, logger.clone() as Arc<Logger>));
7634                 let watchtower = test_utils::TestChannelMonitor::new(chain_monitor, &chanmon_cfgs[0].tx_broadcaster, logger.clone(), &chanmon_cfgs[0].fee_estimator);
7635                 assert!(watchtower.add_monitor(outpoint, new_monitor).is_ok());
7636                 watchtower
7637         };
7638         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7639         watchtower.simple_monitor.block_connected(&header, 200, &vec![], &vec![]);
7640
7641         // Try to update ChannelMonitor
7642         assert!(nodes[1].node.claim_funds(preimage, &None, 9_000_000));
7643         check_added_monitors!(nodes[1], 1);
7644         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7645         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
7646         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
7647         if let Some(ref mut channel) = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&chan_1.2) {
7648                 if let Ok((_, _, _, update)) = channel.commitment_signed(&updates.commitment_signed, &node_cfgs[0].fee_estimator) {
7649                         if let Err(_) =  watchtower.simple_monitor.update_monitor(outpoint, update.clone()) {} else { assert!(false); }
7650                         if let Ok(_) = nodes[0].chan_monitor.update_monitor(outpoint, update) {} else { assert!(false); }
7651                 } else { assert!(false); }
7652         } else { assert!(false); };
7653         // Our local monitor is in-sync and hasn't processed yet timeout
7654         check_added_monitors!(nodes[0], 1);
7655         let events = nodes[0].node.get_and_clear_pending_events();
7656         assert_eq!(events.len(), 1);
7657 }