_ 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::{ChainListener, ChainWatchInterfaceUtil, BlockNotifier};
   8 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
   9 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, PaymentSecret, PaymentSendFailure, BREAKDOWN_TIMEOUT};
  10 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
  11 use ln::channel::{Channel, ChannelError};
  12 use ln::{chan_utils, onion_utils};
  13 use ln::router::{Route, RouteHop};
  14 use ln::features::{ChannelFeatures, InitFeatures, NodeFeatures};
  15 use ln::msgs;
  16 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, ErrorAction};
  17 use util::enforcing_trait_impls::EnforcingChannelKeys;
  18 use util::test_utils;
  19 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  20 use util::errors::APIError;
  21 use util::ser::{Writeable, Writer, ReadableArgs};
  22 use util::config::UserConfig;
  23 use util::logger::Logger;
  24
  25 use bitcoin::util::hash::BitcoinHash;
  26 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
  27 use bitcoin::util::bip143;
  28 use bitcoin::util::address::Address;
  29 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  30 use bitcoin::blockdata::block::{Block, BlockHeader};
  31 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  32 use bitcoin::blockdata::script::{Builder, Script};
  33 use bitcoin::blockdata::opcodes;
  34 use bitcoin::blockdata::constants::genesis_block;
  35 use bitcoin::network::constants::Network;
  36
  37 use bitcoin_hashes::sha256::Hash as Sha256;
  38 use bitcoin_hashes::Hash;
  39
  40 use secp256k1::{Secp256k1, Message};
  41 use secp256k1::key::{PublicKey,SecretKey};
  42
  43 use std::collections::{BTreeSet, HashMap, HashSet};
  44 use std::default::Default;
  45 use std::sync::{Arc, Mutex};
  46 use std::sync::atomic::Ordering;
  47 use std::{mem, io};
  48
  49 use rand::{thread_rng, Rng};
  50
  51 use ln::functional_test_utils::*;
  52
  53 #[test]
  54 fn test_insane_channel_opens() {
  55         // Stand up a network of 2 nodes
  56         let chanmon_cfgs = create_chanmon_cfgs(2);
  57         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
  58         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
  59         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
  60
  61         // Instantiate channel parameters where we push the maximum msats given our
  62         // funding satoshis
  63         let channel_value_sat = 31337; // same as funding satoshis
  64         let channel_reserve_satoshis = Channel::<EnforcingChannelKeys>::get_our_channel_reserve_satoshis(channel_value_sat);
  65         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  66
  67         // Have node0 initiate a channel to node1 with aforementioned parameters
  68         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42, None).unwrap();
  69
  70         // Extract the channel open message from node0 to node1
  71         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  72
  73         // Test helper that asserts we get the correct error string given a mutator
  74         // that supposedly makes the channel open message insane
  75         let insane_open_helper = |expected_error_str: &str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  76                 nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &message_mutator(open_channel_message.clone()));
  77                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
  78                 assert_eq!(msg_events.len(), 1);
  79                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
  80                         match action {
  81                                 &ErrorAction::SendErrorMessage { .. } => {
  82                                         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), expected_error_str.to_string(), 1);
  83                                 },
  84                                 _ => panic!("unexpected event!"),
  85                         }
  86                 } else { assert!(false); }
  87         };
  88
  89         use ln::channel::MAX_FUNDING_SATOSHIS;
  90         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  91
  92         // Test all mutations that would make the channel open message insane
  93         insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
  94
  95         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
  96
  97         insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
  98
  99         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
 100
 101         insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
 102
 103         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 });
 104
 105         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 });
 106
 107         insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 108
 109         insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 110 }
 111
 112 #[test]
 113 fn test_async_inbound_update_fee() {
 114         let chanmon_cfgs = create_chanmon_cfgs(2);
 115         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 116         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 117         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 118         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 119         let channel_id = chan.2;
 120
 121         // balancing
 122         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 123
 124         // A                                        B
 125         // update_fee                            ->
 126         // send (1) commitment_signed            -.
 127         //                                       <- update_add_htlc/commitment_signed
 128         // send (2) RAA (awaiting remote revoke) -.
 129         // (1) commitment_signed is delivered    ->
 130         //                                       .- send (3) RAA (awaiting remote revoke)
 131         // (2) RAA is delivered                  ->
 132         //                                       .- send (4) commitment_signed
 133         //                                       <- (3) RAA is delivered
 134         // send (5) commitment_signed            -.
 135         //                                       <- (4) commitment_signed is delivered
 136         // send (6) RAA                          -.
 137         // (5) commitment_signed is delivered    ->
 138         //                                       <- RAA
 139         // (6) RAA is delivered                  ->
 140
 141         // First nodes[0] generates an update_fee
 142         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 143         check_added_monitors!(nodes[0], 1);
 144
 145         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 146         assert_eq!(events_0.len(), 1);
 147         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 148                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 149                         (update_fee.as_ref(), commitment_signed)
 150                 },
 151                 _ => panic!("Unexpected event"),
 152         };
 153
 154         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 155
 156         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 157         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 158         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();
 159         check_added_monitors!(nodes[1], 1);
 160
 161         let payment_event = {
 162                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 163                 assert_eq!(events_1.len(), 1);
 164                 SendEvent::from_event(events_1.remove(0))
 165         };
 166         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 167         assert_eq!(payment_event.msgs.len(), 1);
 168
 169         // ...now when the messages get delivered everyone should be happy
 170         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 171         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 172         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 173         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 174         check_added_monitors!(nodes[0], 1);
 175
 176         // deliver(1), generate (3):
 177         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 178         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 179         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 180         check_added_monitors!(nodes[1], 1);
 181
 182         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack); // deliver (2)
 183         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 184         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 185         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 186         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 187         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 188         assert!(bs_update.update_fee.is_none()); // (4)
 189         check_added_monitors!(nodes[1], 1);
 190
 191         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack); // deliver (3)
 192         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 193         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 194         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 195         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 196         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 197         assert!(as_update.update_fee.is_none()); // (5)
 198         check_added_monitors!(nodes[0], 1);
 199
 200         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed); // deliver (4)
 201         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 202         // only (6) so get_event_msg's assert(len == 1) passes
 203         check_added_monitors!(nodes[0], 1);
 204
 205         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed); // deliver (5)
 206         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 207         check_added_monitors!(nodes[1], 1);
 208
 209         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 210         check_added_monitors!(nodes[0], 1);
 211
 212         let events_2 = nodes[0].node.get_and_clear_pending_events();
 213         assert_eq!(events_2.len(), 1);
 214         match events_2[0] {
 215                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 216                 _ => panic!("Unexpected event"),
 217         }
 218
 219         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke); // deliver (6)
 220         check_added_monitors!(nodes[1], 1);
 221 }
 222
 223 #[test]
 224 fn test_update_fee_unordered_raa() {
 225         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 226         // crash in an earlier version of the update_fee patch)
 227         let chanmon_cfgs = create_chanmon_cfgs(2);
 228         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 229         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 230         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 231         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 232         let channel_id = chan.2;
 233
 234         // balancing
 235         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 236
 237         // First nodes[0] generates an update_fee
 238         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 239         check_added_monitors!(nodes[0], 1);
 240
 241         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 242         assert_eq!(events_0.len(), 1);
 243         let update_msg = match events_0[0] { // (1)
 244                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 245                         update_fee.as_ref()
 246                 },
 247                 _ => panic!("Unexpected event"),
 248         };
 249
 250         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 251
 252         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 253         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 254         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();
 255         check_added_monitors!(nodes[1], 1);
 256
 257         let payment_event = {
 258                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 259                 assert_eq!(events_1.len(), 1);
 260                 SendEvent::from_event(events_1.remove(0))
 261         };
 262         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 263         assert_eq!(payment_event.msgs.len(), 1);
 264
 265         // ...now when the messages get delivered everyone should be happy
 266         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
 267         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg); // (2)
 268         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 269         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 270         check_added_monitors!(nodes[0], 1);
 271
 272         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg); // deliver (2)
 273         check_added_monitors!(nodes[1], 1);
 274
 275         // We can't continue, sadly, because our (1) now has a bogus signature
 276 }
 277
 278 #[test]
 279 fn test_multi_flight_update_fee() {
 280         let chanmon_cfgs = create_chanmon_cfgs(2);
 281         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 282         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 283         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 284         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 285         let channel_id = chan.2;
 286
 287         // A                                        B
 288         // update_fee/commitment_signed          ->
 289         //                                       .- send (1) RAA and (2) commitment_signed
 290         // update_fee (never committed)          ->
 291         // (3) update_fee                        ->
 292         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 293         // don't track which updates correspond to which revoke_and_ack responses so we're in
 294         // AwaitingRAA mode and will not generate the update_fee yet.
 295         //                                       <- (1) RAA delivered
 296         // (3) is generated and send (4) CS      -.
 297         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 298         // know the per_commitment_point to use for it.
 299         //                                       <- (2) commitment_signed delivered
 300         // revoke_and_ack                        ->
 301         //                                          B should send no response here
 302         // (4) commitment_signed delivered       ->
 303         //                                       <- RAA/commitment_signed delivered
 304         // revoke_and_ack                        ->
 305
 306         // First nodes[0] generates an update_fee
 307         let initial_feerate = get_feerate!(nodes[0], channel_id);
 308         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 309         check_added_monitors!(nodes[0], 1);
 310
 311         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 312         assert_eq!(events_0.len(), 1);
 313         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 314                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 315                         (update_fee.as_ref().unwrap(), commitment_signed)
 316                 },
 317                 _ => panic!("Unexpected event"),
 318         };
 319
 320         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 321         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1);
 322         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1);
 323         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 324         check_added_monitors!(nodes[1], 1);
 325
 326         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 327         // transaction:
 328         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 329         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 330         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 331
 332         // Create the (3) update_fee message that nodes[0] will generate before it does...
 333         let mut update_msg_2 = msgs::UpdateFee {
 334                 channel_id: update_msg_1.channel_id.clone(),
 335                 feerate_per_kw: (initial_feerate + 30) as u32,
 336         };
 337
 338         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 339
 340         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 341         // Deliver (3)
 342         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2);
 343
 344         // Deliver (1), generating (3) and (4)
 345         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg);
 346         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 347         check_added_monitors!(nodes[0], 1);
 348         assert!(as_second_update.update_add_htlcs.is_empty());
 349         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 350         assert!(as_second_update.update_fail_htlcs.is_empty());
 351         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 352         // Check that the update_fee newly generated matches what we delivered:
 353         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 354         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 355
 356         // Deliver (2) commitment_signed
 357         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
 358         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 359         check_added_monitors!(nodes[0], 1);
 360         // No commitment_signed so get_event_msg's assert(len == 1) passes
 361
 362         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg);
 363         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 364         check_added_monitors!(nodes[1], 1);
 365
 366         // Delever (4)
 367         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed);
 368         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 369         check_added_monitors!(nodes[1], 1);
 370
 371         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke);
 372         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 373         check_added_monitors!(nodes[0], 1);
 374
 375         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment);
 376         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 377         // No commitment_signed so get_event_msg's assert(len == 1) passes
 378         check_added_monitors!(nodes[0], 1);
 379
 380         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke);
 381         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 382         check_added_monitors!(nodes[1], 1);
 383 }
 384
 385 #[test]
 386 fn test_1_conf_open() {
 387         // Previously, if the minium_depth config was set to 1, we'd never send a funding_locked. This
 388         // tests that we properly send one in that case.
 389         let mut alice_config = UserConfig::default();
 390         alice_config.own_channel_config.minimum_depth = 1;
 391         alice_config.channel_options.announced_channel = true;
 392         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
 393         let mut bob_config = UserConfig::default();
 394         bob_config.own_channel_config.minimum_depth = 1;
 395         bob_config.channel_options.announced_channel = true;
 396         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
 397         let chanmon_cfgs = create_chanmon_cfgs(2);
 398         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 399         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[Some(alice_config), Some(bob_config)]);
 400         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 401
 402         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
 403         assert!(nodes[0].chain_monitor.does_match_tx(&tx));
 404         assert!(nodes[1].chain_monitor.does_match_tx(&tx));
 405
 406         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 407         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
 408         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()));
 409
 410         nodes[0].block_notifier.block_connected_checked(&header, 1, &[&tx; 1], &[tx.version; 1]);
 411         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 412         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
 413
 414         for node in nodes {
 415                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
 416                 node.router.handle_channel_update(&as_update).unwrap();
 417                 node.router.handle_channel_update(&bs_update).unwrap();
 418         }
 419 }
 420
 421 fn do_test_sanity_on_in_flight_opens(steps: u8) {
 422         // Previously, we had issues deserializing channels when we hadn't connected the first block
 423         // after creation. To catch that and similar issues, we lean on the Node::drop impl to test
 424         // serialization round-trips and simply do steps towards opening a channel and then drop the
 425         // Node objects.
 426
 427         let chanmon_cfgs = create_chanmon_cfgs(2);
 428         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 429         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 430         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 431
 432         if steps & 0b1000_0000 != 0{
 433                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 434                 nodes[0].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 435                 nodes[1].block_notifier.block_connected_checked(&header, 1, &Vec::new(), &[0; 0]);
 436         }
 437
 438         if steps & 0x0f == 0 { return; }
 439         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 100000, 10001, 42, None).unwrap();
 440         let open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
 441
 442         if steps & 0x0f == 1 { return; }
 443         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &open_channel);
 444         let accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
 445
 446         if steps & 0x0f == 2 { return; }
 447         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
 448
 449         let (temporary_channel_id, tx, funding_output) = create_funding_transaction(&nodes[0], 100000, 42);
 450
 451         if steps & 0x0f == 3 { return; }
 452         {
 453                 nodes[0].node.funding_transaction_generated(&temporary_channel_id, funding_output);
 454                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 455                 assert_eq!(added_monitors.len(), 1);
 456                 assert_eq!(added_monitors[0].0, funding_output);
 457                 added_monitors.clear();
 458         }
 459         let funding_created = get_event_msg!(nodes[0], MessageSendEvent::SendFundingCreated, nodes[1].node.get_our_node_id());
 460
 461         if steps & 0x0f == 4 { return; }
 462         nodes[1].node.handle_funding_created(&nodes[0].node.get_our_node_id(), &funding_created);
 463         {
 464                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
 465                 assert_eq!(added_monitors.len(), 1);
 466                 assert_eq!(added_monitors[0].0, funding_output);
 467                 added_monitors.clear();
 468         }
 469         let funding_signed = get_event_msg!(nodes[1], MessageSendEvent::SendFundingSigned, nodes[0].node.get_our_node_id());
 470
 471         if steps & 0x0f == 5 { return; }
 472         nodes[0].node.handle_funding_signed(&nodes[1].node.get_our_node_id(), &funding_signed);
 473         {
 474                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 475                 assert_eq!(added_monitors.len(), 1);
 476                 assert_eq!(added_monitors[0].0, funding_output);
 477                 added_monitors.clear();
 478         }
 479
 480         let events_4 = nodes[0].node.get_and_clear_pending_events();
 481         assert_eq!(events_4.len(), 1);
 482         match events_4[0] {
 483                 Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
 484                         assert_eq!(user_channel_id, 42);
 485                         assert_eq!(*funding_txo, funding_output);
 486                 },
 487                 _ => panic!("Unexpected event"),
 488         };
 489
 490         if steps & 0x0f == 6 { return; }
 491         create_chan_between_nodes_with_value_confirm_first(&nodes[0], &nodes[1], &tx);
 492
 493         if steps & 0x0f == 7 { return; }
 494         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
 495         create_chan_between_nodes_with_value_confirm_second(&nodes[1], &nodes[0]);
 496 }
 497
 498 #[test]
 499 fn test_sanity_on_in_flight_opens() {
 500         do_test_sanity_on_in_flight_opens(0);
 501         do_test_sanity_on_in_flight_opens(0 | 0b1000_0000);
 502         do_test_sanity_on_in_flight_opens(1);
 503         do_test_sanity_on_in_flight_opens(1 | 0b1000_0000);
 504         do_test_sanity_on_in_flight_opens(2);
 505         do_test_sanity_on_in_flight_opens(2 | 0b1000_0000);
 506         do_test_sanity_on_in_flight_opens(3);
 507         do_test_sanity_on_in_flight_opens(3 | 0b1000_0000);
 508         do_test_sanity_on_in_flight_opens(4);
 509         do_test_sanity_on_in_flight_opens(4 | 0b1000_0000);
 510         do_test_sanity_on_in_flight_opens(5);
 511         do_test_sanity_on_in_flight_opens(5 | 0b1000_0000);
 512         do_test_sanity_on_in_flight_opens(6);
 513         do_test_sanity_on_in_flight_opens(6 | 0b1000_0000);
 514         do_test_sanity_on_in_flight_opens(7);
 515         do_test_sanity_on_in_flight_opens(7 | 0b1000_0000);
 516         do_test_sanity_on_in_flight_opens(8);
 517         do_test_sanity_on_in_flight_opens(8 | 0b1000_0000);
 518 }
 519
 520 #[test]
 521 fn test_update_fee_vanilla() {
 522         let chanmon_cfgs = create_chanmon_cfgs(2);
 523         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 524         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 525         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 526         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 527         let channel_id = chan.2;
 528
 529         let feerate = get_feerate!(nodes[0], channel_id);
 530         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 531         check_added_monitors!(nodes[0], 1);
 532
 533         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 534         assert_eq!(events_0.len(), 1);
 535         let (update_msg, commitment_signed) = match events_0[0] {
 536                         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 } } => {
 537                         (update_fee.as_ref(), commitment_signed)
 538                 },
 539                 _ => panic!("Unexpected event"),
 540         };
 541         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 542
 543         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 544         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 545         check_added_monitors!(nodes[1], 1);
 546
 547         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 548         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 549         check_added_monitors!(nodes[0], 1);
 550
 551         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 552         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 553         // No commitment_signed so get_event_msg's assert(len == 1) passes
 554         check_added_monitors!(nodes[0], 1);
 555
 556         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 557         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 558         check_added_monitors!(nodes[1], 1);
 559 }
 560
 561 #[test]
 562 fn test_update_fee_that_funder_cannot_afford() {
 563         let chanmon_cfgs = create_chanmon_cfgs(2);
 564         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 565         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 566         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 567         let channel_value = 1888;
 568         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, InitFeatures::supported(), InitFeatures::supported());
 569         let channel_id = chan.2;
 570
 571         let feerate = 260;
 572         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 573         check_added_monitors!(nodes[0], 1);
 574         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 575
 576         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap());
 577
 578         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 579
 580         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 581         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 582         {
 583                 let commitment_tx = get_local_commitment_txn!(nodes[1], channel_id)[0].clone();
 584
 585                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 586                 let num_htlcs = commitment_tx.output.len() - 2;
 587                 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 588                 let mut actual_fee = commitment_tx.output.iter().fold(0, |acc, output| acc + output.value);
 589                 actual_fee = channel_value - actual_fee;
 590                 assert_eq!(total_fee, actual_fee);
 591         }
 592
 593         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 594         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 595         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 596         check_added_monitors!(nodes[0], 1);
 597
 598         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 599
 600         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap());
 601
 602         //While producing the commitment_signed response after handling a received update_fee request the
 603         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 604         //Should produce and error.
 605         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed);
 606         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Funding remote cannot afford proposed new fee".to_string(), 1);
 607         check_added_monitors!(nodes[1], 1);
 608         check_closed_broadcast!(nodes[1], true);
 609 }
 610
 611 #[test]
 612 fn test_update_fee_with_fundee_update_add_htlc() {
 613         let chanmon_cfgs = create_chanmon_cfgs(2);
 614         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 615         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 616         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 617         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 618         let channel_id = chan.2;
 619
 620         // balancing
 621         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 622
 623         let feerate = get_feerate!(nodes[0], channel_id);
 624         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 625         check_added_monitors!(nodes[0], 1);
 626
 627         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 628         assert_eq!(events_0.len(), 1);
 629         let (update_msg, commitment_signed) = match events_0[0] {
 630                         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 } } => {
 631                         (update_fee.as_ref(), commitment_signed)
 632                 },
 633                 _ => panic!("Unexpected event"),
 634         };
 635         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 636         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 637         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 638         check_added_monitors!(nodes[1], 1);
 639
 640         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
 641
 642         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 643
 644         // nothing happens since node[1] is in AwaitingRemoteRevoke
 645         nodes[1].node.send_payment(&route, our_payment_hash, &None).unwrap();
 646         {
 647                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 648                 assert_eq!(added_monitors.len(), 0);
 649                 added_monitors.clear();
 650         }
 651         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 652         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 653         // node[1] has nothing to do
 654
 655         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 656         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 657         check_added_monitors!(nodes[0], 1);
 658
 659         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
 660         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 661         // No commitment_signed so get_event_msg's assert(len == 1) passes
 662         check_added_monitors!(nodes[0], 1);
 663         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 664         check_added_monitors!(nodes[1], 1);
 665         // AwaitingRemoteRevoke ends here
 666
 667         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 668         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 669         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 670         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 671         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 672         assert_eq!(commitment_update.update_fee.is_none(), true);
 673
 674         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]);
 675         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 676         check_added_monitors!(nodes[0], 1);
 677         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 678
 679         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke);
 680         check_added_monitors!(nodes[1], 1);
 681         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 682
 683         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed);
 684         check_added_monitors!(nodes[1], 1);
 685         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 686         // No commitment_signed so get_event_msg's assert(len == 1) passes
 687
 688         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke);
 689         check_added_monitors!(nodes[0], 1);
 690         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 691
 692         expect_pending_htlcs_forwardable!(nodes[0]);
 693
 694         let events = nodes[0].node.get_and_clear_pending_events();
 695         assert_eq!(events.len(), 1);
 696         match events[0] {
 697                 Event::PaymentReceived { .. } => { },
 698                 _ => panic!("Unexpected event"),
 699         };
 700
 701         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 702
 703         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 704         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 705         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 706 }
 707
 708 #[test]
 709 fn test_update_fee() {
 710         let chanmon_cfgs = create_chanmon_cfgs(2);
 711         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 712         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 713         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 714         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 715         let channel_id = chan.2;
 716
 717         // A                                        B
 718         // (1) update_fee/commitment_signed      ->
 719         //                                       <- (2) revoke_and_ack
 720         //                                       .- send (3) commitment_signed
 721         // (4) update_fee/commitment_signed      ->
 722         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 723         //                                       <- (3) commitment_signed delivered
 724         // send (6) revoke_and_ack               -.
 725         //                                       <- (5) deliver revoke_and_ack
 726         // (6) deliver revoke_and_ack            ->
 727         //                                       .- send (7) commitment_signed in response to (4)
 728         //                                       <- (7) deliver commitment_signed
 729         // revoke_and_ack                        ->
 730
 731         // Create and deliver (1)...
 732         let feerate = get_feerate!(nodes[0], channel_id);
 733         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 734         check_added_monitors!(nodes[0], 1);
 735
 736         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 737         assert_eq!(events_0.len(), 1);
 738         let (update_msg, commitment_signed) = match events_0[0] {
 739                         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 } } => {
 740                         (update_fee.as_ref(), commitment_signed)
 741                 },
 742                 _ => panic!("Unexpected event"),
 743         };
 744         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 745
 746         // Generate (2) and (3):
 747         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 748         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 749         check_added_monitors!(nodes[1], 1);
 750
 751         // Deliver (2):
 752         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 753         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 754         check_added_monitors!(nodes[0], 1);
 755
 756         // Create and deliver (4)...
 757         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 758         check_added_monitors!(nodes[0], 1);
 759         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 760         assert_eq!(events_0.len(), 1);
 761         let (update_msg, commitment_signed) = match events_0[0] {
 762                         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 } } => {
 763                         (update_fee.as_ref(), commitment_signed)
 764                 },
 765                 _ => panic!("Unexpected event"),
 766         };
 767
 768         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap());
 769         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed);
 770         check_added_monitors!(nodes[1], 1);
 771         // ... creating (5)
 772         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 773         // No commitment_signed so get_event_msg's assert(len == 1) passes
 774
 775         // Handle (3), creating (6):
 776         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0);
 777         check_added_monitors!(nodes[0], 1);
 778         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 779         // No commitment_signed so get_event_msg's assert(len == 1) passes
 780
 781         // Deliver (5):
 782         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg);
 783         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 784         check_added_monitors!(nodes[0], 1);
 785
 786         // Deliver (6), creating (7):
 787         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0);
 788         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 789         assert!(commitment_update.update_add_htlcs.is_empty());
 790         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 791         assert!(commitment_update.update_fail_htlcs.is_empty());
 792         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 793         assert!(commitment_update.update_fee.is_none());
 794         check_added_monitors!(nodes[1], 1);
 795
 796         // Deliver (7)
 797         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed);
 798         check_added_monitors!(nodes[0], 1);
 799         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 800         // No commitment_signed so get_event_msg's assert(len == 1) passes
 801
 802         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg);
 803         check_added_monitors!(nodes[1], 1);
 804         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 805
 806         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 807         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 808         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 809 }
 810
 811 #[test]
 812 fn pre_funding_lock_shutdown_test() {
 813         // Test sending a shutdown prior to funding_locked after funding generation
 814         let chanmon_cfgs = create_chanmon_cfgs(2);
 815         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
 816         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
 817         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
 818         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, InitFeatures::supported(), InitFeatures::supported());
 819         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 820         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 821         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 822
 823         nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
 824         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 825         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 826         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 827         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 828
 829         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 830         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 831         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 832         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 833         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 834         assert!(node_0_none.is_none());
 835
 836         assert!(nodes[0].node.list_channels().is_empty());
 837         assert!(nodes[1].node.list_channels().is_empty());
 838 }
 839
 840 #[test]
 841 fn updates_shutdown_wait() {
 842         // Test sending a shutdown with outstanding updates pending
 843         let chanmon_cfgs = create_chanmon_cfgs(3);
 844         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 845         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 846         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 847         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 848         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 849         let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 850         let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 851
 852         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 853
 854         nodes[0].node.close_channel(&chan_1.2).unwrap();
 855         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 856         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 857         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 858         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 859
 860         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 861         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 862
 863         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 864         unwrap_send_err!(nodes[0].node.send_payment(&route_1, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 865         unwrap_send_err!(nodes[1].node.send_payment(&route_2, payment_hash, &None), true, APIError::ChannelUnavailable {..}, {});
 866
 867         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
 868         check_added_monitors!(nodes[2], 1);
 869         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 870         assert!(updates.update_add_htlcs.is_empty());
 871         assert!(updates.update_fail_htlcs.is_empty());
 872         assert!(updates.update_fail_malformed_htlcs.is_empty());
 873         assert!(updates.update_fee.is_none());
 874         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 875         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 876         check_added_monitors!(nodes[1], 1);
 877         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 878         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 879
 880         assert!(updates_2.update_add_htlcs.is_empty());
 881         assert!(updates_2.update_fail_htlcs.is_empty());
 882         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 883         assert!(updates_2.update_fee.is_none());
 884         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 885         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 886         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 887
 888         let events = nodes[0].node.get_and_clear_pending_events();
 889         assert_eq!(events.len(), 1);
 890         match events[0] {
 891                 Event::PaymentSent { ref payment_preimage } => {
 892                         assert_eq!(our_payment_preimage, *payment_preimage);
 893                 },
 894                 _ => panic!("Unexpected event"),
 895         }
 896
 897         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 898         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 899         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 900         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 901         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 902         assert!(node_0_none.is_none());
 903
 904         assert!(nodes[0].node.list_channels().is_empty());
 905
 906         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 907         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 908         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 909         assert!(nodes[1].node.list_channels().is_empty());
 910         assert!(nodes[2].node.list_channels().is_empty());
 911 }
 912
 913 #[test]
 914 fn htlc_fail_async_shutdown() {
 915         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 916         let chanmon_cfgs = create_chanmon_cfgs(3);
 917         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 918         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 919         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 920         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 921         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 922
 923         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 924         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 925         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
 926         check_added_monitors!(nodes[0], 1);
 927         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 928         assert_eq!(updates.update_add_htlcs.len(), 1);
 929         assert!(updates.update_fulfill_htlcs.is_empty());
 930         assert!(updates.update_fail_htlcs.is_empty());
 931         assert!(updates.update_fail_malformed_htlcs.is_empty());
 932         assert!(updates.update_fee.is_none());
 933
 934         nodes[1].node.close_channel(&chan_1.2).unwrap();
 935         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 936         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 937         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 938
 939         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 940         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 941         check_added_monitors!(nodes[1], 1);
 942         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 943         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 944
 945         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 946         assert!(updates_2.update_add_htlcs.is_empty());
 947         assert!(updates_2.update_fulfill_htlcs.is_empty());
 948         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 949         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 950         assert!(updates_2.update_fee.is_none());
 951
 952         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 953         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 954
 955         let events = nodes[0].node.get_and_clear_pending_events();
 956         assert_eq!(events.len(), 1);
 957         match events[0] {
 958                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
 959                         assert_eq!(our_payment_hash, *payment_hash);
 960                         assert!(!rejected_by_dest);
 961                 },
 962                 _ => panic!("Unexpected event"),
 963         }
 964
 965         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 966         assert_eq!(msg_events.len(), 2);
 967         let node_0_closing_signed = match msg_events[0] {
 968                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 969                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 970                         (*msg).clone()
 971                 },
 972                 _ => panic!("Unexpected event"),
 973         };
 974         match msg_events[1] {
 975                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 976                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 977                 },
 978                 _ => panic!("Unexpected event"),
 979         }
 980
 981         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 982         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 983         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 984         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 985         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 986         assert!(node_0_none.is_none());
 987
 988         assert!(nodes[0].node.list_channels().is_empty());
 989
 990         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 991         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 992         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 993         assert!(nodes[1].node.list_channels().is_empty());
 994         assert!(nodes[2].node.list_channels().is_empty());
 995 }
 996
 997 fn do_test_shutdown_rebroadcast(recv_count: u8) {
 998         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
 999         // messages delivered prior to disconnect
1000         let chanmon_cfgs = create_chanmon_cfgs(3);
1001         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1002         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1003         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1004         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1005         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1006
1007         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1008
1009         nodes[1].node.close_channel(&chan_1.2).unwrap();
1010         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1011         if recv_count > 0 {
1012                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1013                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1014                 if recv_count > 1 {
1015                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1016                 }
1017         }
1018
1019         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1020         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1021
1022         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1023         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1024         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1025         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1026
1027         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1028         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1029         assert!(node_1_shutdown == node_1_2nd_shutdown);
1030
1031         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1032         let node_0_2nd_shutdown = if recv_count > 0 {
1033                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1034                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1035                 node_0_2nd_shutdown
1036         } else {
1037                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1038                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1039                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1040         };
1041         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1042
1043         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1044         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1045
1046         assert!(nodes[2].node.claim_funds(our_payment_preimage, &None, 100_000));
1047         check_added_monitors!(nodes[2], 1);
1048         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1049         assert!(updates.update_add_htlcs.is_empty());
1050         assert!(updates.update_fail_htlcs.is_empty());
1051         assert!(updates.update_fail_malformed_htlcs.is_empty());
1052         assert!(updates.update_fee.is_none());
1053         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1054         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1055         check_added_monitors!(nodes[1], 1);
1056         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1057         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1058
1059         assert!(updates_2.update_add_htlcs.is_empty());
1060         assert!(updates_2.update_fail_htlcs.is_empty());
1061         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1062         assert!(updates_2.update_fee.is_none());
1063         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1064         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1065         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1066
1067         let events = nodes[0].node.get_and_clear_pending_events();
1068         assert_eq!(events.len(), 1);
1069         match events[0] {
1070                 Event::PaymentSent { ref payment_preimage } => {
1071                         assert_eq!(our_payment_preimage, *payment_preimage);
1072                 },
1073                 _ => panic!("Unexpected event"),
1074         }
1075
1076         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1077         if recv_count > 0 {
1078                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1079                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1080                 assert!(node_1_closing_signed.is_some());
1081         }
1082
1083         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1084         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1085
1086         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1087         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1088         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1089         if recv_count == 0 {
1090                 // If all closing_signeds weren't delivered we can just resume where we left off...
1091                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1092
1093                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1094                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1095                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1096
1097                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1098                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1099                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1100
1101                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1102                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1103
1104                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1105                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1106                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1107
1108                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1109                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1110                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1111                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1112                 assert!(node_0_none.is_none());
1113         } else {
1114                 // If one node, however, received + responded with an identical closing_signed we end
1115                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1116                 // There isn't really anything better we can do simply, but in the future we might
1117                 // explore storing a set of recently-closed channels that got disconnected during
1118                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1119                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1120                 // transaction.
1121                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1122
1123                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1124                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1125                 assert_eq!(msg_events.len(), 1);
1126                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1127                         match action {
1128                                 &ErrorAction::SendErrorMessage { ref msg } => {
1129                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1130                                         assert_eq!(msg.channel_id, chan_1.2);
1131                                 },
1132                                 _ => panic!("Unexpected event!"),
1133                         }
1134                 } else { panic!("Needed SendErrorMessage close"); }
1135
1136                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1137                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1138                 // closing_signed so we do it ourselves
1139                 check_closed_broadcast!(nodes[0], false);
1140                 check_added_monitors!(nodes[0], 1);
1141         }
1142
1143         assert!(nodes[0].node.list_channels().is_empty());
1144
1145         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1146         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1147         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1148         assert!(nodes[1].node.list_channels().is_empty());
1149         assert!(nodes[2].node.list_channels().is_empty());
1150 }
1151
1152 #[test]
1153 fn test_shutdown_rebroadcast() {
1154         do_test_shutdown_rebroadcast(0);
1155         do_test_shutdown_rebroadcast(1);
1156         do_test_shutdown_rebroadcast(2);
1157 }
1158
1159 #[test]
1160 fn fake_network_test() {
1161         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1162         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1163         let chanmon_cfgs = create_chanmon_cfgs(4);
1164         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1165         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1166         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1167
1168         // Create some initial channels
1169         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1170         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1171         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1172
1173         // Rebalance the network a bit by relaying one payment through all the channels...
1174         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1175         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
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
1179         // Send some more payments
1180         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1181         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1182         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1183
1184         // Test failure packets
1185         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1186         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1187
1188         // Add a new channel that skips 3
1189         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1190
1191         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1192         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1193         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1194         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1195         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
1199         // Do some rebalance loop payments, simultaneously
1200         let mut hops = Vec::with_capacity(3);
1201         hops.push(RouteHop {
1202                 pubkey: nodes[2].node.get_our_node_id(),
1203                 node_features: NodeFeatures::empty(),
1204                 short_channel_id: chan_2.0.contents.short_channel_id,
1205                 channel_features: ChannelFeatures::empty(),
1206                 fee_msat: 0,
1207                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1208         });
1209         hops.push(RouteHop {
1210                 pubkey: nodes[3].node.get_our_node_id(),
1211                 node_features: NodeFeatures::empty(),
1212                 short_channel_id: chan_3.0.contents.short_channel_id,
1213                 channel_features: ChannelFeatures::empty(),
1214                 fee_msat: 0,
1215                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1216         });
1217         hops.push(RouteHop {
1218                 pubkey: nodes[1].node.get_our_node_id(),
1219                 node_features: NodeFeatures::empty(),
1220                 short_channel_id: chan_4.0.contents.short_channel_id,
1221                 channel_features: ChannelFeatures::empty(),
1222                 fee_msat: 1000000,
1223                 cltv_expiry_delta: TEST_FINAL_CLTV,
1224         });
1225         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;
1226         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;
1227         let payment_preimage_1 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1228
1229         let mut hops = Vec::with_capacity(3);
1230         hops.push(RouteHop {
1231                 pubkey: nodes[3].node.get_our_node_id(),
1232                 node_features: NodeFeatures::empty(),
1233                 short_channel_id: chan_4.0.contents.short_channel_id,
1234                 channel_features: ChannelFeatures::empty(),
1235                 fee_msat: 0,
1236                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1237         });
1238         hops.push(RouteHop {
1239                 pubkey: nodes[2].node.get_our_node_id(),
1240                 node_features: NodeFeatures::empty(),
1241                 short_channel_id: chan_3.0.contents.short_channel_id,
1242                 channel_features: ChannelFeatures::empty(),
1243                 fee_msat: 0,
1244                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1245         });
1246         hops.push(RouteHop {
1247                 pubkey: nodes[1].node.get_our_node_id(),
1248                 node_features: NodeFeatures::empty(),
1249                 short_channel_id: chan_2.0.contents.short_channel_id,
1250                 channel_features: ChannelFeatures::empty(),
1251                 fee_msat: 1000000,
1252                 cltv_expiry_delta: TEST_FINAL_CLTV,
1253         });
1254         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;
1255         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;
1256         let payment_hash_2 = send_along_route(&nodes[1], Route { paths: vec![hops] }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1257
1258         // Claim the rebalances...
1259         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1260         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1261
1262         // Add a duplicate new channel from 2 to 4
1263         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1264
1265         // Send some payments across both channels
1266         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1267         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1268         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1269
1270
1271         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1272         let events = nodes[0].node.get_and_clear_pending_msg_events();
1273         assert_eq!(events.len(), 0);
1274         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);
1275
1276         //TODO: Test that routes work again here as we've been notified that the channel is full
1277
1278         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1279         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1280         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1281
1282         // Close down the channels...
1283         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1284         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1285         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1286         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1287         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1288 }
1289
1290 #[test]
1291 fn holding_cell_htlc_counting() {
1292         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1293         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1294         // commitment dance rounds.
1295         let chanmon_cfgs = create_chanmon_cfgs(3);
1296         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1297         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1298         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1299         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1300         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1301
1302         let mut payments = Vec::new();
1303         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1304                 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1305                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1306                 nodes[1].node.send_payment(&route, payment_hash, &None).unwrap();
1307                 payments.push((payment_preimage, payment_hash));
1308         }
1309         check_added_monitors!(nodes[1], 1);
1310
1311         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1312         assert_eq!(events.len(), 1);
1313         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1314         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1315
1316         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1317         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1318         // another HTLC.
1319         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1320         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1321         unwrap_send_err!(nodes[1].node.send_payment(&route, payment_hash_1, &None), true, APIError::ChannelUnavailable { err },
1322                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
1323         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1324         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1325
1326         // This should also be true if we try to forward a payment.
1327         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1328         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1329         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
1330         check_added_monitors!(nodes[0], 1);
1331
1332         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1333         assert_eq!(events.len(), 1);
1334         let payment_event = SendEvent::from_event(events.pop().unwrap());
1335         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1336
1337         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1338         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1339         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1340         // fails), the second will process the resulting failure and fail the HTLC backward.
1341         expect_pending_htlcs_forwardable!(nodes[1]);
1342         expect_pending_htlcs_forwardable!(nodes[1]);
1343         check_added_monitors!(nodes[1], 1);
1344
1345         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1346         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1347         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1348
1349         let events = nodes[0].node.get_and_clear_pending_msg_events();
1350         assert_eq!(events.len(), 1);
1351         match events[0] {
1352                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1353                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1354                 },
1355                 _ => panic!("Unexpected event"),
1356         }
1357
1358         let events = nodes[0].node.get_and_clear_pending_events();
1359         assert_eq!(events.len(), 1);
1360         match events[0] {
1361                 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1362                         assert_eq!(payment_hash, payment_hash_2);
1363                         assert!(!rejected_by_dest);
1364                 },
1365                 _ => panic!("Unexpected event"),
1366         }
1367
1368         // Now forward all the pending HTLCs and claim them back
1369         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1370         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1371         check_added_monitors!(nodes[2], 1);
1372
1373         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1374         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1375         check_added_monitors!(nodes[1], 1);
1376         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1377
1378         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1379         check_added_monitors!(nodes[1], 1);
1380         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1381
1382         for ref update in as_updates.update_add_htlcs.iter() {
1383                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1384         }
1385         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1386         check_added_monitors!(nodes[2], 1);
1387         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1388         check_added_monitors!(nodes[2], 1);
1389         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1390
1391         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1392         check_added_monitors!(nodes[1], 1);
1393         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1394         check_added_monitors!(nodes[1], 1);
1395         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1396
1397         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1398         check_added_monitors!(nodes[2], 1);
1399
1400         expect_pending_htlcs_forwardable!(nodes[2]);
1401
1402         let events = nodes[2].node.get_and_clear_pending_events();
1403         assert_eq!(events.len(), payments.len());
1404         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1405                 match event {
1406                         &Event::PaymentReceived { ref payment_hash, .. } => {
1407                                 assert_eq!(*payment_hash, *hash);
1408                         },
1409                         _ => panic!("Unexpected event"),
1410                 };
1411         }
1412
1413         for (preimage, _) in payments.drain(..) {
1414                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1415         }
1416
1417         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1418 }
1419
1420 #[test]
1421 fn duplicate_htlc_test() {
1422         // Test that we accept duplicate payment_hash HTLCs across the network and that
1423         // claiming/failing them are all separate and don't affect each other
1424         let chanmon_cfgs = create_chanmon_cfgs(6);
1425         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1426         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1427         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1428
1429         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1430         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1431         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1432         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1433         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1434         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1435
1436         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1437
1438         *nodes[0].network_payment_count.borrow_mut() -= 1;
1439         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1440
1441         *nodes[0].network_payment_count.borrow_mut() -= 1;
1442         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1443
1444         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1445         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1446         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1447 }
1448
1449 #[test]
1450 fn test_duplicate_htlc_different_direction_onchain() {
1451         // Test that ChannelMonitor doesn't generate 2 preimage txn
1452         // when we have 2 HTLCs with same preimage that go across a node
1453         // in opposite directions.
1454         let chanmon_cfgs = create_chanmon_cfgs(2);
1455         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1456         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1457         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1458
1459         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1460
1461         // balancing
1462         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1463
1464         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1465
1466         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1467         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1468
1469         // Provide preimage to node 0 by claiming payment
1470         nodes[0].node.claim_funds(payment_preimage, &None, 800_000);
1471         check_added_monitors!(nodes[0], 1);
1472
1473         // Broadcast node 1 commitment txn
1474         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1475
1476         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1477         let mut has_both_htlcs = 0; // check htlcs match ones committed
1478         for outp in remote_txn[0].output.iter() {
1479                 if outp.value == 800_000 / 1000 {
1480                         has_both_htlcs += 1;
1481                 } else if outp.value == 900_000 / 1000 {
1482                         has_both_htlcs += 1;
1483                 }
1484         }
1485         assert_eq!(has_both_htlcs, 2);
1486
1487         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1488         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1489         check_added_monitors!(nodes[0], 1);
1490
1491         // Check we only broadcast 1 timeout tx
1492         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1493         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()) };
1494         assert_eq!(claim_txn.len(), 5);
1495         check_spends!(claim_txn[2], chan_1.3);
1496         check_spends!(claim_txn[3], claim_txn[2]);
1497         assert_eq!(htlc_pair.0.input.len(), 1);
1498         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1499         check_spends!(htlc_pair.0, remote_txn[0]);
1500         assert_eq!(htlc_pair.1.input.len(), 1);
1501         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1502         check_spends!(htlc_pair.1, remote_txn[0]);
1503
1504         let events = nodes[0].node.get_and_clear_pending_msg_events();
1505         assert_eq!(events.len(), 2);
1506         for e in events {
1507                 match e {
1508                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1509                         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, .. } } => {
1510                                 assert!(update_add_htlcs.is_empty());
1511                                 assert!(update_fail_htlcs.is_empty());
1512                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1513                                 assert!(update_fail_malformed_htlcs.is_empty());
1514                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1515                         },
1516                         _ => panic!("Unexpected event"),
1517                 }
1518         }
1519 }
1520
1521 fn do_channel_reserve_test(test_recv: bool) {
1522
1523         let chanmon_cfgs = create_chanmon_cfgs(3);
1524         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1525         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1526         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1527         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1528         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1529
1530         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1531         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1532
1533         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1534         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1535
1536         macro_rules! get_route_and_payment_hash {
1537                 ($recv_value: expr) => {{
1538                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1539                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1540                         (route, payment_hash, payment_preimage)
1541                 }}
1542         };
1543
1544         macro_rules! expect_forward {
1545                 ($node: expr) => {{
1546                         let mut events = $node.node.get_and_clear_pending_msg_events();
1547                         assert_eq!(events.len(), 1);
1548                         check_added_monitors!($node, 1);
1549                         let payment_event = SendEvent::from_event(events.remove(0));
1550                         payment_event
1551                 }}
1552         }
1553
1554         let feemsat = 239; // somehow we know?
1555         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1556
1557         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1558
1559         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1560         {
1561                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1562                 assert!(route.paths[0].iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1563                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1564                         assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
1565                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1566                 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);
1567         }
1568
1569         let mut htlc_id = 0;
1570         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1571         // nodes[0]'s wealth
1572         loop {
1573                 let amt_msat = recv_value_0 + total_fee_msat;
1574                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1575                         break;
1576                 }
1577                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1578                 htlc_id += 1;
1579
1580                 let (stat01_, stat11_, stat12_, stat22_) = (
1581                         get_channel_value_stat!(nodes[0], chan_1.2),
1582                         get_channel_value_stat!(nodes[1], chan_1.2),
1583                         get_channel_value_stat!(nodes[1], chan_2.2),
1584                         get_channel_value_stat!(nodes[2], chan_2.2),
1585                 );
1586
1587                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1588                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1589                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1590                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1591                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1592         }
1593
1594         {
1595                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1596                 // attempt to get channel_reserve violation
1597                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1598                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1599                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1600                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1601                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1602         }
1603
1604         // adding pending output
1605         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1606         let amt_msat_1 = recv_value_1 + total_fee_msat;
1607
1608         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1609         let payment_event_1 = {
1610                 nodes[0].node.send_payment(&route_1, our_payment_hash_1, &None).unwrap();
1611                 check_added_monitors!(nodes[0], 1);
1612
1613                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1614                 assert_eq!(events.len(), 1);
1615                 SendEvent::from_event(events.remove(0))
1616         };
1617         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1618
1619         // channel reserve test with htlc pending output > 0
1620         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1621         {
1622                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1623                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1624                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1625                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1626                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1627         }
1628
1629         {
1630                 // test channel_reserve test on nodes[1] side
1631                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1632
1633                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1634                 let secp_ctx = Secp256k1::new();
1635                 let session_priv = SecretKey::from_slice(&{
1636                         let mut session_key = [0; 32];
1637                         let mut rng = thread_rng();
1638                         rng.fill_bytes(&mut session_key);
1639                         session_key
1640                 }).expect("RNG is bad!");
1641
1642                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1643                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
1644                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], recv_value_2 + 1, &None, cur_height).unwrap();
1645                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1646                 let msg = msgs::UpdateAddHTLC {
1647                         channel_id: chan_1.2,
1648                         htlc_id,
1649                         amount_msat: htlc_msat,
1650                         payment_hash: our_payment_hash,
1651                         cltv_expiry: htlc_cltv,
1652                         onion_routing_packet: onion_packet,
1653                 };
1654
1655                 if test_recv {
1656                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1657                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1658                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1659                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1660                         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1661                         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1662                         check_added_monitors!(nodes[1], 1);
1663                         return;
1664                 }
1665         }
1666
1667         // split the rest to test holding cell
1668         let recv_value_21 = recv_value_2/2;
1669         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1670         {
1671                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1672                 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);
1673         }
1674
1675         // now see if they go through on both sides
1676         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1677         // but this will stuck in the holding cell
1678         nodes[0].node.send_payment(&route_21, our_payment_hash_21, &None).unwrap();
1679         check_added_monitors!(nodes[0], 0);
1680         let events = nodes[0].node.get_and_clear_pending_events();
1681         assert_eq!(events.len(), 0);
1682
1683         // test with outbound holding cell amount > 0
1684         {
1685                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1686                 unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
1687                         assert_eq!(err, "Cannot send value that would put us over their reserve value"));
1688                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1689                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1690         }
1691
1692         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1693         // this will also stuck in the holding cell
1694         nodes[0].node.send_payment(&route_22, our_payment_hash_22, &None).unwrap();
1695         check_added_monitors!(nodes[0], 0);
1696         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1697         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1698
1699         // flush the pending htlc
1700         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1701         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1702         check_added_monitors!(nodes[1], 1);
1703
1704         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1705         check_added_monitors!(nodes[0], 1);
1706         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1707
1708         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1709         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1710         // No commitment_signed so get_event_msg's assert(len == 1) passes
1711         check_added_monitors!(nodes[0], 1);
1712
1713         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1714         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1715         check_added_monitors!(nodes[1], 1);
1716
1717         expect_pending_htlcs_forwardable!(nodes[1]);
1718
1719         let ref payment_event_11 = expect_forward!(nodes[1]);
1720         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1721         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1722
1723         expect_pending_htlcs_forwardable!(nodes[2]);
1724         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1725
1726         // flush the htlcs in the holding cell
1727         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1728         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1729         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1730         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1731         expect_pending_htlcs_forwardable!(nodes[1]);
1732
1733         let ref payment_event_3 = expect_forward!(nodes[1]);
1734         assert_eq!(payment_event_3.msgs.len(), 2);
1735         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1736         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1737
1738         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1739         expect_pending_htlcs_forwardable!(nodes[2]);
1740
1741         let events = nodes[2].node.get_and_clear_pending_events();
1742         assert_eq!(events.len(), 2);
1743         match events[0] {
1744                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1745                         assert_eq!(our_payment_hash_21, *payment_hash);
1746                         assert_eq!(*payment_secret, None);
1747                         assert_eq!(recv_value_21, amt);
1748                 },
1749                 _ => panic!("Unexpected event"),
1750         }
1751         match events[1] {
1752                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
1753                         assert_eq!(our_payment_hash_22, *payment_hash);
1754                         assert_eq!(None, *payment_secret);
1755                         assert_eq!(recv_value_22, amt);
1756                 },
1757                 _ => panic!("Unexpected event"),
1758         }
1759
1760         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1761         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1762         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1763
1764         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);
1765         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1766         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1767         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1768
1769         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1770         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1771 }
1772
1773 #[test]
1774 fn channel_reserve_test() {
1775         do_channel_reserve_test(false);
1776         do_channel_reserve_test(true);
1777 }
1778
1779 #[test]
1780 fn channel_reserve_in_flight_removes() {
1781         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1782         // can send to its counterparty, but due to update ordering, the other side may not yet have
1783         // considered those HTLCs fully removed.
1784         // This tests that we don't count HTLCs which will not be included in the next remote
1785         // commitment transaction towards the reserve value (as it implies no commitment transaction
1786         // will be generated which violates the remote reserve value).
1787         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1788         // To test this we:
1789         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1790         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1791         //    you only consider the value of the first HTLC, it may not),
1792         //  * start routing a third HTLC from A to B,
1793         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1794         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1795         //  * deliver the first fulfill from B
1796         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1797         //    claim,
1798         //  * deliver A's response CS and RAA.
1799         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1800         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1801         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1802         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1803         let chanmon_cfgs = create_chanmon_cfgs(2);
1804         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1805         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1806         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1807         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1808
1809         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1810         // Route the first two HTLCs.
1811         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1812         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1813
1814         // Start routing the third HTLC (this is just used to get everyone in the right state).
1815         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1816         let send_1 = {
1817                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1818                 nodes[0].node.send_payment(&route, payment_hash_3, &None).unwrap();
1819                 check_added_monitors!(nodes[0], 1);
1820                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1821                 assert_eq!(events.len(), 1);
1822                 SendEvent::from_event(events.remove(0))
1823         };
1824
1825         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1826         // initial fulfill/CS.
1827         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1828         check_added_monitors!(nodes[1], 1);
1829         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1830
1831         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1832         // remove the second HTLC when we send the HTLC back from B to A.
1833         assert!(nodes[1].node.claim_funds(payment_preimage_2, &None, 20000));
1834         check_added_monitors!(nodes[1], 1);
1835         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1836
1837         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1838         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1839         check_added_monitors!(nodes[0], 1);
1840         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1841         expect_payment_sent!(nodes[0], payment_preimage_1);
1842
1843         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1844         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1845         check_added_monitors!(nodes[1], 1);
1846         // B is already AwaitingRAA, so cant generate a CS here
1847         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1848
1849         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1850         check_added_monitors!(nodes[1], 1);
1851         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1852
1853         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1854         check_added_monitors!(nodes[0], 1);
1855         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1856
1857         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1858         check_added_monitors!(nodes[1], 1);
1859         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1860
1861         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1862         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1863         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1864         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1865         // on-chain as necessary).
1866         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1867         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1868         check_added_monitors!(nodes[0], 1);
1869         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1870         expect_payment_sent!(nodes[0], payment_preimage_2);
1871
1872         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1873         check_added_monitors!(nodes[1], 1);
1874         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1875
1876         expect_pending_htlcs_forwardable!(nodes[1]);
1877         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1878
1879         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1880         // resolve the second HTLC from A's point of view.
1881         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1882         check_added_monitors!(nodes[0], 1);
1883         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1884
1885         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1886         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1887         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1888         let send_2 = {
1889                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1890                 nodes[1].node.send_payment(&route, payment_hash_4, &None).unwrap();
1891                 check_added_monitors!(nodes[1], 1);
1892                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1893                 assert_eq!(events.len(), 1);
1894                 SendEvent::from_event(events.remove(0))
1895         };
1896
1897         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1898         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1899         check_added_monitors!(nodes[0], 1);
1900         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1901
1902         // Now just resolve all the outstanding messages/HTLCs for completeness...
1903
1904         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1905         check_added_monitors!(nodes[1], 1);
1906         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1907
1908         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1909         check_added_monitors!(nodes[1], 1);
1910
1911         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1912         check_added_monitors!(nodes[0], 1);
1913         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1914
1915         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1916         check_added_monitors!(nodes[1], 1);
1917         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1918
1919         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1920         check_added_monitors!(nodes[0], 1);
1921
1922         expect_pending_htlcs_forwardable!(nodes[0]);
1923         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1924
1925         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1926         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1927 }
1928
1929 #[test]
1930 fn channel_monitor_network_test() {
1931         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1932         // tests that ChannelMonitor is able to recover from various states.
1933         let chanmon_cfgs = create_chanmon_cfgs(5);
1934         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1935         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1936         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1937
1938         // Create some initial channels
1939         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1940         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1941         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1942         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1943
1944         // Rebalance the network a bit by relaying one payment through all the channels...
1945         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1946         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
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
1950         // Simple case with no pending HTLCs:
1951         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1952         check_added_monitors!(nodes[1], 1);
1953         {
1954                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1955                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1956                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1957                 check_added_monitors!(nodes[0], 1);
1958                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1959         }
1960         get_announce_close_broadcast_events(&nodes, 0, 1);
1961         assert_eq!(nodes[0].node.list_channels().len(), 0);
1962         assert_eq!(nodes[1].node.list_channels().len(), 1);
1963
1964         // One pending HTLC is discarded by the force-close:
1965         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1966
1967         // Simple case of one pending HTLC to HTLC-Timeout
1968         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1969         check_added_monitors!(nodes[1], 1);
1970         {
1971                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1972                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1973                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1974                 check_added_monitors!(nodes[2], 1);
1975                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1976         }
1977         get_announce_close_broadcast_events(&nodes, 1, 2);
1978         assert_eq!(nodes[1].node.list_channels().len(), 0);
1979         assert_eq!(nodes[2].node.list_channels().len(), 1);
1980
1981         macro_rules! claim_funds {
1982                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1983                         {
1984                                 assert!($node.node.claim_funds($preimage, &None, $amount));
1985                                 check_added_monitors!($node, 1);
1986
1987                                 let events = $node.node.get_and_clear_pending_msg_events();
1988                                 assert_eq!(events.len(), 1);
1989                                 match events[0] {
1990                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1991                                                 assert!(update_add_htlcs.is_empty());
1992                                                 assert!(update_fail_htlcs.is_empty());
1993                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1994                                         },
1995                                         _ => panic!("Unexpected event"),
1996                                 };
1997                         }
1998                 }
1999         }
2000
2001         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2002         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2003         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2004         check_added_monitors!(nodes[2], 1);
2005         let node2_commitment_txid;
2006         {
2007                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2008                 node2_commitment_txid = node_txn[0].txid();
2009
2010                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2011                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2012
2013                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2014                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2015                 check_added_monitors!(nodes[3], 1);
2016
2017                 check_preimage_claim(&nodes[3], &node_txn);
2018         }
2019         get_announce_close_broadcast_events(&nodes, 2, 3);
2020         assert_eq!(nodes[2].node.list_channels().len(), 0);
2021         assert_eq!(nodes[3].node.list_channels().len(), 1);
2022
2023         { // Cheat and reset nodes[4]'s height to 1
2024                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2025                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2026         }
2027
2028         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2029         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2030         // One pending HTLC to time out:
2031         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2032         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2033         // buffer space).
2034
2035         {
2036                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2037                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2038                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2039                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2040                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2041                 }
2042                 check_added_monitors!(nodes[3], 1);
2043
2044                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2045                 {
2046                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2047                         node_txn.retain(|tx| {
2048                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2049                                         false
2050                                 } else { true }
2051                         });
2052                 }
2053
2054                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2055
2056                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2057                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2058
2059                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2060
2061                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2062                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2063                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2064                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2065                 }
2066
2067                 check_added_monitors!(nodes[4], 1);
2068                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2069
2070                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2071                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2072
2073                 check_preimage_claim(&nodes[4], &node_txn);
2074         }
2075         get_announce_close_broadcast_events(&nodes, 3, 4);
2076         assert_eq!(nodes[3].node.list_channels().len(), 0);
2077         assert_eq!(nodes[4].node.list_channels().len(), 0);
2078 }
2079
2080 #[test]
2081 fn test_justice_tx() {
2082         // Test justice txn built on revoked HTLC-Success tx, against both sides
2083         let mut alice_config = UserConfig::default();
2084         alice_config.channel_options.announced_channel = true;
2085         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2086         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2087         let mut bob_config = UserConfig::default();
2088         bob_config.channel_options.announced_channel = true;
2089         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2090         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2091         let user_cfgs = [Some(alice_config), Some(bob_config)];
2092         let chanmon_cfgs = create_chanmon_cfgs(2);
2093         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2094         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2095         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2096         // Create some new channels:
2097         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2098
2099         // A pending HTLC which will be revoked:
2100         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2101         // Get the will-be-revoked local txn from nodes[0]
2102         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2103         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2104         assert_eq!(revoked_local_txn[0].input.len(), 1);
2105         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2106         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2107         assert_eq!(revoked_local_txn[1].input.len(), 1);
2108         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2109         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2110         // Revoke the old state
2111         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2112
2113         {
2114                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2115                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2116                 {
2117                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2118                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2119                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2120
2121                         check_spends!(node_txn[0], revoked_local_txn[0]);
2122                         node_txn.swap_remove(0);
2123                         node_txn.truncate(1);
2124                 }
2125                 check_added_monitors!(nodes[1], 1);
2126                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2127
2128                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2129                 // Verify broadcast of revoked HTLC-timeout
2130                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2131                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2132                 check_added_monitors!(nodes[0], 1);
2133                 // Broadcast revoked HTLC-timeout on node 1
2134                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2135                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2136         }
2137         get_announce_close_broadcast_events(&nodes, 0, 1);
2138
2139         assert_eq!(nodes[0].node.list_channels().len(), 0);
2140         assert_eq!(nodes[1].node.list_channels().len(), 0);
2141
2142         // We test justice_tx build by A on B's revoked HTLC-Success tx
2143         // Create some new channels:
2144         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2145         {
2146                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2147                 node_txn.clear();
2148         }
2149
2150         // A pending HTLC which will be revoked:
2151         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2152         // Get the will-be-revoked local txn from B
2153         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2154         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2155         assert_eq!(revoked_local_txn[0].input.len(), 1);
2156         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2157         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2158         // Revoke the old state
2159         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2160         {
2161                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2162                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2163                 {
2164                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2165                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2166                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2167
2168                         check_spends!(node_txn[0], revoked_local_txn[0]);
2169                         node_txn.swap_remove(0);
2170                 }
2171                 check_added_monitors!(nodes[0], 1);
2172                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2173
2174                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2175                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2176                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2177                 check_added_monitors!(nodes[1], 1);
2178                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2179                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2180         }
2181         get_announce_close_broadcast_events(&nodes, 0, 1);
2182         assert_eq!(nodes[0].node.list_channels().len(), 0);
2183         assert_eq!(nodes[1].node.list_channels().len(), 0);
2184 }
2185
2186 #[test]
2187 fn revoked_output_claim() {
2188         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2189         // transaction is broadcast by its counterparty
2190         let chanmon_cfgs = create_chanmon_cfgs(2);
2191         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2192         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2193         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2194         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2195         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2196         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2197         assert_eq!(revoked_local_txn.len(), 1);
2198         // Only output is the full channel value back to nodes[0]:
2199         assert_eq!(revoked_local_txn[0].output.len(), 1);
2200         // Send a payment through, updating everyone's latest commitment txn
2201         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2202
2203         // Inform nodes[1] that nodes[0] broadcast a stale tx
2204         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2205         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2206         check_added_monitors!(nodes[1], 1);
2207         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2208         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2209
2210         check_spends!(node_txn[0], revoked_local_txn[0]);
2211         check_spends!(node_txn[1], chan_1.3);
2212
2213         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2214         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2215         get_announce_close_broadcast_events(&nodes, 0, 1);
2216         check_added_monitors!(nodes[0], 1)
2217 }
2218
2219 #[test]
2220 fn claim_htlc_outputs_shared_tx() {
2221         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2222         let chanmon_cfgs = create_chanmon_cfgs(2);
2223         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2224         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2225         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2226
2227         // Create some new channel:
2228         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2229
2230         // Rebalance the network to generate htlc in the two directions
2231         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2232         // 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
2233         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2234         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2235
2236         // Get the will-be-revoked local txn from node[0]
2237         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2238         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2239         assert_eq!(revoked_local_txn[0].input.len(), 1);
2240         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2241         assert_eq!(revoked_local_txn[1].input.len(), 1);
2242         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2243         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2244         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2245
2246         //Revoke the old state
2247         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2248
2249         {
2250                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2251                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2252                 check_added_monitors!(nodes[0], 1);
2253                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2254                 check_added_monitors!(nodes[1], 1);
2255                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2256
2257                 let events = nodes[1].node.get_and_clear_pending_events();
2258                 assert_eq!(events.len(), 1);
2259                 match events[0] {
2260                         Event::PaymentFailed { payment_hash, .. } => {
2261                                 assert_eq!(payment_hash, payment_hash_2);
2262                         },
2263                         _ => panic!("Unexpected event"),
2264                 }
2265
2266                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2267                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2268
2269                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2270                 check_spends!(node_txn[0], revoked_local_txn[0]);
2271
2272                 let mut witness_lens = BTreeSet::new();
2273                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2274                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2275                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2276                 assert_eq!(witness_lens.len(), 3);
2277                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2278                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2279                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2280
2281                 // Next nodes[1] broadcasts its current local tx state:
2282                 assert_eq!(node_txn[1].input.len(), 1);
2283                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2284
2285                 assert_eq!(node_txn[2].input.len(), 1);
2286                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2287                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2288                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2289                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2290                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2291         }
2292         get_announce_close_broadcast_events(&nodes, 0, 1);
2293         assert_eq!(nodes[0].node.list_channels().len(), 0);
2294         assert_eq!(nodes[1].node.list_channels().len(), 0);
2295 }
2296
2297 #[test]
2298 fn claim_htlc_outputs_single_tx() {
2299         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2300         let chanmon_cfgs = create_chanmon_cfgs(2);
2301         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2302         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2303         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2304
2305         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2306
2307         // Rebalance the network to generate htlc in the two directions
2308         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2309         // 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
2310         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2311         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2312         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2313
2314         // Get the will-be-revoked local txn from node[0]
2315         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2316
2317         //Revoke the old state
2318         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2319
2320         {
2321                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2322                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2323                 check_added_monitors!(nodes[0], 1);
2324                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2325                 check_added_monitors!(nodes[1], 1);
2326                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2327
2328                 let events = nodes[1].node.get_and_clear_pending_events();
2329                 assert_eq!(events.len(), 1);
2330                 match events[0] {
2331                         Event::PaymentFailed { payment_hash, .. } => {
2332                                 assert_eq!(payment_hash, payment_hash_2);
2333                         },
2334                         _ => panic!("Unexpected event"),
2335                 }
2336
2337                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2338                 assert_eq!(node_txn.len(), 21);
2339                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2340                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2341                 // ChannelMonitor: bumped justice tx (4), after one increase, bumps on HTLC aren't generated not being substantial anymore
2342                 // ChannelMonito r: local commitment + local HTLC-timeout (14)
2343
2344                 assert_eq!(node_txn[0], node_txn[5]);
2345                 assert_eq!(node_txn[0], node_txn[7]);
2346                 assert_eq!(node_txn[0], node_txn[9]);
2347                 assert_eq!(node_txn[0], node_txn[13]);
2348                 assert_eq!(node_txn[0], node_txn[15]);
2349                 assert_eq!(node_txn[0], node_txn[17]);
2350                 assert_eq!(node_txn[0], node_txn[19]);
2351
2352                 assert_eq!(node_txn[1], node_txn[6]);
2353                 assert_eq!(node_txn[1], node_txn[8]);
2354                 assert_eq!(node_txn[1], node_txn[10]);
2355                 assert_eq!(node_txn[1], node_txn[14]);
2356                 assert_eq!(node_txn[1], node_txn[16]);
2357                 assert_eq!(node_txn[1], node_txn[18]);
2358                 assert_eq!(node_txn[1], node_txn[20]);
2359
2360
2361                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration and present 8 times (rebroadcast at every block from 200 to 206)
2362                 assert_eq!(node_txn[0].input.len(), 1);
2363                 check_spends!(node_txn[0], chan_1.3);
2364                 assert_eq!(node_txn[1].input.len(), 1);
2365                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2366                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2367                 check_spends!(node_txn[1], node_txn[0]);
2368
2369                 // Justice transactions are indices 2-3-4
2370                 assert_eq!(node_txn[2].input.len(), 1);
2371                 assert_eq!(node_txn[3].input.len(), 1);
2372                 assert_eq!(node_txn[4].input.len(), 1);
2373                 check_spends!(node_txn[2], revoked_local_txn[0]);
2374                 check_spends!(node_txn[3], revoked_local_txn[0]);
2375                 check_spends!(node_txn[4], revoked_local_txn[0]);
2376
2377                 let mut witness_lens = BTreeSet::new();
2378                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2379                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2380                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2381                 assert_eq!(witness_lens.len(), 3);
2382                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2383                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2384                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2385         }
2386         get_announce_close_broadcast_events(&nodes, 0, 1);
2387         assert_eq!(nodes[0].node.list_channels().len(), 0);
2388         assert_eq!(nodes[1].node.list_channels().len(), 0);
2389 }
2390
2391 #[test]
2392 fn test_htlc_on_chain_success() {
2393         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2394         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2395         // broadcasting the right event to other nodes in payment path.
2396         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2397         // A --------------------> B ----------------------> C (preimage)
2398         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2399         // commitment transaction was broadcast.
2400         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2401         // towards B.
2402         // B should be able to claim via preimage if A then broadcasts its local tx.
2403         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2404         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2405         // PaymentSent event).
2406
2407         let chanmon_cfgs = create_chanmon_cfgs(3);
2408         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2409         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2410         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2411
2412         // Create some initial channels
2413         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2414         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2415
2416         // Rebalance the network a bit by relaying one payment through all the channels...
2417         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2418         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2419
2420         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2421         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2422         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2423
2424         // Broadcast legit commitment tx from C on B's chain
2425         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2426         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2427         assert_eq!(commitment_tx.len(), 1);
2428         check_spends!(commitment_tx[0], chan_2.3);
2429         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2430         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2431         check_added_monitors!(nodes[2], 2);
2432         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2433         assert!(updates.update_add_htlcs.is_empty());
2434         assert!(updates.update_fail_htlcs.is_empty());
2435         assert!(updates.update_fail_malformed_htlcs.is_empty());
2436         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2437
2438         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2439         check_closed_broadcast!(nodes[2], false);
2440         check_added_monitors!(nodes[2], 1);
2441         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 4 (2*2 * HTLC-Success tx)
2442         assert_eq!(node_txn.len(), 7);
2443         assert_eq!(node_txn[0], node_txn[3]);
2444         assert_eq!(node_txn[1], node_txn[4]);
2445         assert_eq!(node_txn[0], node_txn[5]);
2446         assert_eq!(node_txn[1], node_txn[6]);
2447         assert_eq!(node_txn[2], commitment_tx[0]);
2448         check_spends!(node_txn[0], commitment_tx[0]);
2449         check_spends!(node_txn[1], commitment_tx[0]);
2450         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2451         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2452         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2453         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2454         assert_eq!(node_txn[0].lock_time, 0);
2455         assert_eq!(node_txn[1].lock_time, 0);
2456
2457         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2458         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2459         {
2460                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2461                 assert_eq!(added_monitors.len(), 1);
2462                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2463                 added_monitors.clear();
2464         }
2465         let events = nodes[1].node.get_and_clear_pending_msg_events();
2466         {
2467                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2468                 assert_eq!(added_monitors.len(), 2);
2469                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2470                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2471                 added_monitors.clear();
2472         }
2473         assert_eq!(events.len(), 2);
2474         match events[0] {
2475                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2476                 _ => panic!("Unexpected event"),
2477         }
2478         match events[1] {
2479                 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, .. } } => {
2480                         assert!(update_add_htlcs.is_empty());
2481                         assert!(update_fail_htlcs.is_empty());
2482                         assert_eq!(update_fulfill_htlcs.len(), 1);
2483                         assert!(update_fail_malformed_htlcs.is_empty());
2484                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2485                 },
2486                 _ => panic!("Unexpected event"),
2487         };
2488         macro_rules! check_tx_local_broadcast {
2489                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2490                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2491                         assert_eq!(node_txn.len(), if $htlc_offered { 7 } else { 5 });
2492                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2493                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout * 2 (block-rescan)
2494                         check_spends!(node_txn[0], $commitment_tx);
2495                         check_spends!(node_txn[1], $commitment_tx);
2496                         if $htlc_offered {
2497                                 assert_eq!(node_txn[0], node_txn[5]);
2498                                 assert_eq!(node_txn[1], node_txn[6]);
2499                         }
2500                         assert_ne!(node_txn[0].lock_time, 0);
2501                         assert_ne!(node_txn[1].lock_time, 0);
2502                         if $htlc_offered {
2503                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2504                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2505                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2506                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2507                         } else {
2508                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2509                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2510                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2511                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2512                         }
2513                         check_spends!(node_txn[2], $chan_tx);
2514                         check_spends!(node_txn[3], node_txn[2]);
2515                         check_spends!(node_txn[4], node_txn[2]);
2516                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2517                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2518                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2519                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2520                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2521                         assert_ne!(node_txn[3].lock_time, 0);
2522                         assert_ne!(node_txn[4].lock_time, 0);
2523                         node_txn.clear();
2524                 } }
2525         }
2526         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2527         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2528         // timeout-claim of the output that nodes[2] just claimed via success.
2529         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2530
2531         // Broadcast legit commitment tx from A on B's chain
2532         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2533         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2534         check_spends!(commitment_tx[0], chan_1.3);
2535         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2536         check_closed_broadcast!(nodes[1], false);
2537         check_added_monitors!(nodes[1], 1);
2538         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2539         assert_eq!(node_txn.len(), 4);
2540         check_spends!(node_txn[0], commitment_tx[0]);
2541         assert_eq!(node_txn[0].input.len(), 2);
2542         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2543         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2544         assert_eq!(node_txn[0].lock_time, 0);
2545         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2546         check_spends!(node_txn[1], chan_1.3);
2547         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2548         check_spends!(node_txn[2], node_txn[1]);
2549         check_spends!(node_txn[3], node_txn[1]);
2550         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2551         // we already checked the same situation with A.
2552
2553         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2554         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2555         check_closed_broadcast!(nodes[0], false);
2556         check_added_monitors!(nodes[0], 1);
2557         let events = nodes[0].node.get_and_clear_pending_events();
2558         assert_eq!(events.len(), 2);
2559         let mut first_claimed = false;
2560         for event in events {
2561                 match event {
2562                         Event::PaymentSent { payment_preimage } => {
2563                                 if payment_preimage == our_payment_preimage {
2564                                         assert!(!first_claimed);
2565                                         first_claimed = true;
2566                                 } else {
2567                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2568                                 }
2569                         },
2570                         _ => panic!("Unexpected event"),
2571                 }
2572         }
2573         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2574 }
2575
2576 #[test]
2577 fn test_htlc_on_chain_timeout() {
2578         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2579         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2580         // broadcasting the right event to other nodes in payment path.
2581         // A ------------------> B ----------------------> C (timeout)
2582         //    B's commitment tx                 C's commitment tx
2583         //            \                                  \
2584         //         B's HTLC timeout tx               B's timeout tx
2585
2586         let chanmon_cfgs = create_chanmon_cfgs(3);
2587         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2588         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2589         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2590
2591         // Create some intial channels
2592         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2593         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2594
2595         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2596         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2597         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2598
2599         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2600         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2601
2602         // Broadcast legit commitment tx from C on B's chain
2603         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2604         check_spends!(commitment_tx[0], chan_2.3);
2605         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2606         check_added_monitors!(nodes[2], 0);
2607         expect_pending_htlcs_forwardable!(nodes[2]);
2608         check_added_monitors!(nodes[2], 1);
2609
2610         let events = nodes[2].node.get_and_clear_pending_msg_events();
2611         assert_eq!(events.len(), 1);
2612         match events[0] {
2613                 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, .. } } => {
2614                         assert!(update_add_htlcs.is_empty());
2615                         assert!(!update_fail_htlcs.is_empty());
2616                         assert!(update_fulfill_htlcs.is_empty());
2617                         assert!(update_fail_malformed_htlcs.is_empty());
2618                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2619                 },
2620                 _ => panic!("Unexpected event"),
2621         };
2622         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2623         check_closed_broadcast!(nodes[2], false);
2624         check_added_monitors!(nodes[2], 1);
2625         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2626         assert_eq!(node_txn.len(), 1);
2627         check_spends!(node_txn[0], chan_2.3);
2628         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2629
2630         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2631         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2632         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2633         let timeout_tx;
2634         {
2635                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2636                 assert_eq!(node_txn.len(), 7); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : (local commitment tx + HTLC-timeout) * 2 (block-rescan), timeout tx
2637                 assert_eq!(node_txn[0], node_txn[3]);
2638                 assert_eq!(node_txn[0], node_txn[5]);
2639                 assert_eq!(node_txn[1], node_txn[4]);
2640                 assert_eq!(node_txn[1], node_txn[6]);
2641
2642                 check_spends!(node_txn[2], commitment_tx[0]);
2643                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2644
2645                 check_spends!(node_txn[0], chan_2.3);
2646                 check_spends!(node_txn[1], node_txn[0]);
2647                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2648                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2649
2650                 timeout_tx = node_txn[2].clone();
2651                 node_txn.clear();
2652         }
2653
2654         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2655         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2656         check_added_monitors!(nodes[1], 1);
2657         check_closed_broadcast!(nodes[1], false);
2658
2659         expect_pending_htlcs_forwardable!(nodes[1]);
2660         check_added_monitors!(nodes[1], 1);
2661         let events = nodes[1].node.get_and_clear_pending_msg_events();
2662         assert_eq!(events.len(), 1);
2663         match events[0] {
2664                 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, .. } } => {
2665                         assert!(update_add_htlcs.is_empty());
2666                         assert!(!update_fail_htlcs.is_empty());
2667                         assert!(update_fulfill_htlcs.is_empty());
2668                         assert!(update_fail_malformed_htlcs.is_empty());
2669                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2670                 },
2671                 _ => panic!("Unexpected event"),
2672         };
2673         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
2674         assert_eq!(node_txn.len(), 0);
2675
2676         // Broadcast legit commitment tx from B on A's chain
2677         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2678         check_spends!(commitment_tx[0], chan_1.3);
2679
2680         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2681         check_closed_broadcast!(nodes[0], false);
2682         check_added_monitors!(nodes[0], 1);
2683         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2684         assert_eq!(node_txn.len(), 3);
2685         check_spends!(node_txn[0], commitment_tx[0]);
2686         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2687         check_spends!(node_txn[1], chan_1.3);
2688         check_spends!(node_txn[2], node_txn[1]);
2689         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2690         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2691 }
2692
2693 #[test]
2694 fn test_simple_commitment_revoked_fail_backward() {
2695         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2696         // and fail backward accordingly.
2697
2698         let chanmon_cfgs = create_chanmon_cfgs(3);
2699         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2700         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2701         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2702
2703         // Create some initial channels
2704         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2705         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2706
2707         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2708         // Get the will-be-revoked local txn from nodes[2]
2709         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2710         // Revoke the old state
2711         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2712
2713         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2714
2715         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2716         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2717         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2718         check_added_monitors!(nodes[1], 1);
2719         check_closed_broadcast!(nodes[1], false);
2720
2721         expect_pending_htlcs_forwardable!(nodes[1]);
2722         check_added_monitors!(nodes[1], 1);
2723         let events = nodes[1].node.get_and_clear_pending_msg_events();
2724         assert_eq!(events.len(), 1);
2725         match events[0] {
2726                 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, .. } } => {
2727                         assert!(update_add_htlcs.is_empty());
2728                         assert_eq!(update_fail_htlcs.len(), 1);
2729                         assert!(update_fulfill_htlcs.is_empty());
2730                         assert!(update_fail_malformed_htlcs.is_empty());
2731                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2732
2733                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2734                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2735
2736                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2737                         assert_eq!(events.len(), 1);
2738                         match events[0] {
2739                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2740                                 _ => panic!("Unexpected event"),
2741                         }
2742                         let events = nodes[0].node.get_and_clear_pending_events();
2743                         assert_eq!(events.len(), 1);
2744                         match events[0] {
2745                                 Event::PaymentFailed { .. } => {},
2746                                 _ => panic!("Unexpected event"),
2747                         }
2748                 },
2749                 _ => panic!("Unexpected event"),
2750         }
2751 }
2752
2753 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2754         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2755         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2756         // commitment transaction anymore.
2757         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2758         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2759         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2760         // technically disallowed and we should probably handle it reasonably.
2761         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2762         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2763         // transactions:
2764         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2765         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2766         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2767         //   and once they revoke the previous commitment transaction (allowing us to send a new
2768         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2769         let chanmon_cfgs = create_chanmon_cfgs(3);
2770         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2771         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2772         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2773
2774         // Create some initial channels
2775         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2776         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2777
2778         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2779         // Get the will-be-revoked local txn from nodes[2]
2780         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2781         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2782         // Revoke the old state
2783         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2784
2785         let value = if use_dust {
2786                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2787                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2788                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2789         } else { 3000000 };
2790
2791         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2792         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2793         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2794
2795         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
2796         expect_pending_htlcs_forwardable!(nodes[2]);
2797         check_added_monitors!(nodes[2], 1);
2798         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2799         assert!(updates.update_add_htlcs.is_empty());
2800         assert!(updates.update_fulfill_htlcs.is_empty());
2801         assert!(updates.update_fail_malformed_htlcs.is_empty());
2802         assert_eq!(updates.update_fail_htlcs.len(), 1);
2803         assert!(updates.update_fee.is_none());
2804         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2805         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2806         // Drop the last RAA from 3 -> 2
2807
2808         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
2809         expect_pending_htlcs_forwardable!(nodes[2]);
2810         check_added_monitors!(nodes[2], 1);
2811         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2812         assert!(updates.update_add_htlcs.is_empty());
2813         assert!(updates.update_fulfill_htlcs.is_empty());
2814         assert!(updates.update_fail_malformed_htlcs.is_empty());
2815         assert_eq!(updates.update_fail_htlcs.len(), 1);
2816         assert!(updates.update_fee.is_none());
2817         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2818         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2819         check_added_monitors!(nodes[1], 1);
2820         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2821         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2822         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2823         check_added_monitors!(nodes[2], 1);
2824
2825         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
2826         expect_pending_htlcs_forwardable!(nodes[2]);
2827         check_added_monitors!(nodes[2], 1);
2828         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2829         assert!(updates.update_add_htlcs.is_empty());
2830         assert!(updates.update_fulfill_htlcs.is_empty());
2831         assert!(updates.update_fail_malformed_htlcs.is_empty());
2832         assert_eq!(updates.update_fail_htlcs.len(), 1);
2833         assert!(updates.update_fee.is_none());
2834         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2835         // At this point first_payment_hash has dropped out of the latest two commitment
2836         // transactions that nodes[1] is tracking...
2837         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2838         check_added_monitors!(nodes[1], 1);
2839         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2840         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2841         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2842         check_added_monitors!(nodes[2], 1);
2843
2844         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2845         // on nodes[2]'s RAA.
2846         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2847         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2848         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
2849         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2850         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2851         check_added_monitors!(nodes[1], 0);
2852
2853         if deliver_bs_raa {
2854                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2855                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2856                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2857                 check_added_monitors!(nodes[1], 1);
2858                 let events = nodes[1].node.get_and_clear_pending_events();
2859                 assert_eq!(events.len(), 1);
2860                 match events[0] {
2861                         Event::PendingHTLCsForwardable { .. } => { },
2862                         _ => panic!("Unexpected event"),
2863                 };
2864                 // Deliberately don't process the pending fail-back so they all fail back at once after
2865                 // block connection just like the !deliver_bs_raa case
2866         }
2867
2868         let mut failed_htlcs = HashSet::new();
2869         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2870
2871         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2872         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2873         check_added_monitors!(nodes[1], 1);
2874         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2875
2876         let events = nodes[1].node.get_and_clear_pending_events();
2877         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2878         match events[0] {
2879                 Event::PaymentFailed { ref payment_hash, .. } => {
2880                         assert_eq!(*payment_hash, fourth_payment_hash);
2881                 },
2882                 _ => panic!("Unexpected event"),
2883         }
2884         if !deliver_bs_raa {
2885                 match events[1] {
2886                         Event::PendingHTLCsForwardable { .. } => { },
2887                         _ => panic!("Unexpected event"),
2888                 };
2889         }
2890         nodes[1].node.process_pending_htlc_forwards();
2891         check_added_monitors!(nodes[1], 1);
2892
2893         let events = nodes[1].node.get_and_clear_pending_msg_events();
2894         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2895         match events[if deliver_bs_raa { 1 } else { 0 }] {
2896                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2897                 _ => panic!("Unexpected event"),
2898         }
2899         if deliver_bs_raa {
2900                 match events[0] {
2901                         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, .. } } => {
2902                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2903                                 assert_eq!(update_add_htlcs.len(), 1);
2904                                 assert!(update_fulfill_htlcs.is_empty());
2905                                 assert!(update_fail_htlcs.is_empty());
2906                                 assert!(update_fail_malformed_htlcs.is_empty());
2907                         },
2908                         _ => panic!("Unexpected event"),
2909                 }
2910         }
2911         match events[if deliver_bs_raa { 2 } else { 1 }] {
2912                 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, .. } } => {
2913                         assert!(update_add_htlcs.is_empty());
2914                         assert_eq!(update_fail_htlcs.len(), 3);
2915                         assert!(update_fulfill_htlcs.is_empty());
2916                         assert!(update_fail_malformed_htlcs.is_empty());
2917                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2918
2919                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2920                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2921                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2922
2923                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2924
2925                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2926                         // If we delivered B's RAA we got an unknown preimage error, not something
2927                         // that we should update our routing table for.
2928                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2929                         for event in events {
2930                                 match event {
2931                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2932                                         _ => panic!("Unexpected event"),
2933                                 }
2934                         }
2935                         let events = nodes[0].node.get_and_clear_pending_events();
2936                         assert_eq!(events.len(), 3);
2937                         match events[0] {
2938                                 Event::PaymentFailed { ref payment_hash, .. } => {
2939                                         assert!(failed_htlcs.insert(payment_hash.0));
2940                                 },
2941                                 _ => panic!("Unexpected event"),
2942                         }
2943                         match events[1] {
2944                                 Event::PaymentFailed { ref payment_hash, .. } => {
2945                                         assert!(failed_htlcs.insert(payment_hash.0));
2946                                 },
2947                                 _ => panic!("Unexpected event"),
2948                         }
2949                         match events[2] {
2950                                 Event::PaymentFailed { ref payment_hash, .. } => {
2951                                         assert!(failed_htlcs.insert(payment_hash.0));
2952                                 },
2953                                 _ => panic!("Unexpected event"),
2954                         }
2955                 },
2956                 _ => panic!("Unexpected event"),
2957         }
2958
2959         assert!(failed_htlcs.contains(&first_payment_hash.0));
2960         assert!(failed_htlcs.contains(&second_payment_hash.0));
2961         assert!(failed_htlcs.contains(&third_payment_hash.0));
2962 }
2963
2964 #[test]
2965 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2966         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2967         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2968         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2969         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2970 }
2971
2972 #[test]
2973 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2974         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2975         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2976         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2977         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2978 }
2979
2980 #[test]
2981 fn fail_backward_pending_htlc_upon_channel_failure() {
2982         let chanmon_cfgs = create_chanmon_cfgs(2);
2983         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2984         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2985         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2986         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::supported(), InitFeatures::supported());
2987
2988         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
2989         {
2990                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
2991                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2992                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
2993                 check_added_monitors!(nodes[0], 1);
2994
2995                 let payment_event = {
2996                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2997                         assert_eq!(events.len(), 1);
2998                         SendEvent::from_event(events.remove(0))
2999                 };
3000                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3001                 assert_eq!(payment_event.msgs.len(), 1);
3002         }
3003
3004         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3005         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3006         {
3007                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
3008                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
3009                 check_added_monitors!(nodes[0], 0);
3010
3011                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3012         }
3013
3014         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3015         {
3016                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
3017                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3018
3019                 let secp_ctx = Secp256k1::new();
3020                 let session_priv = {
3021                         let mut session_key = [0; 32];
3022                         let mut rng = thread_rng();
3023                         rng.fill_bytes(&mut session_key);
3024                         SecretKey::from_slice(&session_key).expect("RNG is bad!")
3025                 };
3026
3027                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3028                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3029                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3030                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3031
3032                 // Send a 0-msat update_add_htlc to fail the channel.
3033                 let update_add_htlc = msgs::UpdateAddHTLC {
3034                         channel_id: chan.2,
3035                         htlc_id: 0,
3036                         amount_msat: 0,
3037                         payment_hash,
3038                         cltv_expiry,
3039                         onion_routing_packet,
3040                 };
3041                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3042         }
3043
3044         // Check that Alice fails backward the pending HTLC from the second payment.
3045         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3046         check_closed_broadcast!(nodes[0], true);
3047         check_added_monitors!(nodes[0], 1);
3048 }
3049
3050 #[test]
3051 fn test_htlc_ignore_latest_remote_commitment() {
3052         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3053         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3054         let chanmon_cfgs = create_chanmon_cfgs(2);
3055         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3056         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3057         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3058         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3059
3060         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3061         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3062         check_closed_broadcast!(nodes[0], false);
3063         check_added_monitors!(nodes[0], 1);
3064
3065         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3066         assert_eq!(node_txn.len(), 2);
3067
3068         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3069         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3070         check_closed_broadcast!(nodes[1], false);
3071         check_added_monitors!(nodes[1], 1);
3072
3073         // Duplicate the block_connected call since this may happen due to other listeners
3074         // registering new transactions
3075         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3076 }
3077
3078 #[test]
3079 fn test_force_close_fail_back() {
3080         // Check which HTLCs are failed-backwards on channel force-closure
3081         let chanmon_cfgs = create_chanmon_cfgs(3);
3082         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3083         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3084         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3085         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3086         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3087
3088         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
3089
3090         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3091
3092         let mut payment_event = {
3093                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3094                 check_added_monitors!(nodes[0], 1);
3095
3096                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3097                 assert_eq!(events.len(), 1);
3098                 SendEvent::from_event(events.remove(0))
3099         };
3100
3101         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3102         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3103
3104         expect_pending_htlcs_forwardable!(nodes[1]);
3105
3106         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3107         assert_eq!(events_2.len(), 1);
3108         payment_event = SendEvent::from_event(events_2.remove(0));
3109         assert_eq!(payment_event.msgs.len(), 1);
3110
3111         check_added_monitors!(nodes[1], 1);
3112         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3113         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3114         check_added_monitors!(nodes[2], 1);
3115         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3116
3117         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3118         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3119         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3120
3121         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3122         check_closed_broadcast!(nodes[2], false);
3123         check_added_monitors!(nodes[2], 1);
3124         let tx = {
3125                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3126                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3127                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3128                 // back to nodes[1] upon timeout otherwise.
3129                 assert_eq!(node_txn.len(), 1);
3130                 node_txn.remove(0)
3131         };
3132
3133         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3134         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3135
3136         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3137         check_closed_broadcast!(nodes[1], false);
3138         check_added_monitors!(nodes[1], 1);
3139
3140         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3141         {
3142                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3143                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
3144                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3145         }
3146         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3147         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3148         assert_eq!(node_txn.len(), 1);
3149         assert_eq!(node_txn[0].input.len(), 1);
3150         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3151         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3152         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3153
3154         check_spends!(node_txn[0], tx);
3155 }
3156
3157 #[test]
3158 fn test_unconf_chan() {
3159         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3160         let chanmon_cfgs = create_chanmon_cfgs(2);
3161         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3162         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3163         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3164         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3165
3166         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3167         assert_eq!(channel_state.by_id.len(), 1);
3168         assert_eq!(channel_state.short_to_id.len(), 1);
3169         mem::drop(channel_state);
3170
3171         let mut headers = Vec::new();
3172         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3173         headers.push(header.clone());
3174         for _i in 2..100 {
3175                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3176                 headers.push(header.clone());
3177         }
3178         let mut height = 99;
3179         while !headers.is_empty() {
3180                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3181                 height -= 1;
3182         }
3183         check_closed_broadcast!(nodes[0], false);
3184         check_added_monitors!(nodes[0], 1);
3185         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3186         assert_eq!(channel_state.by_id.len(), 0);
3187         assert_eq!(channel_state.short_to_id.len(), 0);
3188 }
3189
3190 #[test]
3191 fn test_simple_peer_disconnect() {
3192         // Test that we can reconnect when there are no lost messages
3193         let chanmon_cfgs = create_chanmon_cfgs(3);
3194         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3195         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3196         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3197         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3198         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3199
3200         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3201         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3202         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3203
3204         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3205         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3206         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3207         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3208
3209         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3210         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3211         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3212
3213         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3214         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3215         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3216         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3217
3218         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3219         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3220
3221         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3222         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3223
3224         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3225         {
3226                 let events = nodes[0].node.get_and_clear_pending_events();
3227                 assert_eq!(events.len(), 2);
3228                 match events[0] {
3229                         Event::PaymentSent { payment_preimage } => {
3230                                 assert_eq!(payment_preimage, payment_preimage_3);
3231                         },
3232                         _ => panic!("Unexpected event"),
3233                 }
3234                 match events[1] {
3235                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3236                                 assert_eq!(payment_hash, payment_hash_5);
3237                                 assert!(rejected_by_dest);
3238                         },
3239                         _ => panic!("Unexpected event"),
3240                 }
3241         }
3242
3243         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3244         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3245 }
3246
3247 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3248         // Test that we can reconnect when in-flight HTLC updates get dropped
3249         let chanmon_cfgs = create_chanmon_cfgs(2);
3250         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3251         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3252         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3253         if messages_delivered == 0 {
3254                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3255                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3256         } else {
3257                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3258         }
3259
3260         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();
3261         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3262
3263         let payment_event = {
3264                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3265                 check_added_monitors!(nodes[0], 1);
3266
3267                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3268                 assert_eq!(events.len(), 1);
3269                 SendEvent::from_event(events.remove(0))
3270         };
3271         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3272
3273         if messages_delivered < 2 {
3274                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3275         } else {
3276                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3277                 if messages_delivered >= 3 {
3278                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3279                         check_added_monitors!(nodes[1], 1);
3280                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3281
3282                         if messages_delivered >= 4 {
3283                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3284                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3285                                 check_added_monitors!(nodes[0], 1);
3286
3287                                 if messages_delivered >= 5 {
3288                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3289                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3290                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3291                                         check_added_monitors!(nodes[0], 1);
3292
3293                                         if messages_delivered >= 6 {
3294                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3295                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3296                                                 check_added_monitors!(nodes[1], 1);
3297                                         }
3298                                 }
3299                         }
3300                 }
3301         }
3302
3303         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3304         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3305         if messages_delivered < 3 {
3306                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3307                 // received on either side, both sides will need to resend them.
3308                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3309         } else if messages_delivered == 3 {
3310                 // nodes[0] still wants its RAA + commitment_signed
3311                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3312         } else if messages_delivered == 4 {
3313                 // nodes[0] still wants its commitment_signed
3314                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3315         } else if messages_delivered == 5 {
3316                 // nodes[1] still wants its final RAA
3317                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3318         } else if messages_delivered == 6 {
3319                 // Everything was delivered...
3320                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3321         }
3322
3323         let events_1 = nodes[1].node.get_and_clear_pending_events();
3324         assert_eq!(events_1.len(), 1);
3325         match events_1[0] {
3326                 Event::PendingHTLCsForwardable { .. } => { },
3327                 _ => panic!("Unexpected event"),
3328         };
3329
3330         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3331         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3332         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3333
3334         nodes[1].node.process_pending_htlc_forwards();
3335
3336         let events_2 = nodes[1].node.get_and_clear_pending_events();
3337         assert_eq!(events_2.len(), 1);
3338         match events_2[0] {
3339                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3340                         assert_eq!(payment_hash_1, *payment_hash);
3341                         assert_eq!(*payment_secret, None);
3342                         assert_eq!(amt, 1000000);
3343                 },
3344                 _ => panic!("Unexpected event"),
3345         }
3346
3347         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3348         check_added_monitors!(nodes[1], 1);
3349
3350         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3351         assert_eq!(events_3.len(), 1);
3352         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3353                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3354                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3355                         assert!(updates.update_add_htlcs.is_empty());
3356                         assert!(updates.update_fail_htlcs.is_empty());
3357                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3358                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3359                         assert!(updates.update_fee.is_none());
3360                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3361                 },
3362                 _ => panic!("Unexpected event"),
3363         };
3364
3365         if messages_delivered >= 1 {
3366                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3367
3368                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3369                 assert_eq!(events_4.len(), 1);
3370                 match events_4[0] {
3371                         Event::PaymentSent { ref payment_preimage } => {
3372                                 assert_eq!(payment_preimage_1, *payment_preimage);
3373                         },
3374                         _ => panic!("Unexpected event"),
3375                 }
3376
3377                 if messages_delivered >= 2 {
3378                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3379                         check_added_monitors!(nodes[0], 1);
3380                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3381
3382                         if messages_delivered >= 3 {
3383                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3384                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3385                                 check_added_monitors!(nodes[1], 1);
3386
3387                                 if messages_delivered >= 4 {
3388                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3389                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3390                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3391                                         check_added_monitors!(nodes[1], 1);
3392
3393                                         if messages_delivered >= 5 {
3394                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3395                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3396                                                 check_added_monitors!(nodes[0], 1);
3397                                         }
3398                                 }
3399                         }
3400                 }
3401         }
3402
3403         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3404         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3405         if messages_delivered < 2 {
3406                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3407                 //TODO: Deduplicate PaymentSent events, then enable this if:
3408                 //if messages_delivered < 1 {
3409                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3410                         assert_eq!(events_4.len(), 1);
3411                         match events_4[0] {
3412                                 Event::PaymentSent { ref payment_preimage } => {
3413                                         assert_eq!(payment_preimage_1, *payment_preimage);
3414                                 },
3415                                 _ => panic!("Unexpected event"),
3416                         }
3417                 //}
3418         } else if messages_delivered == 2 {
3419                 // nodes[0] still wants its RAA + commitment_signed
3420                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3421         } else if messages_delivered == 3 {
3422                 // nodes[0] still wants its commitment_signed
3423                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3424         } else if messages_delivered == 4 {
3425                 // nodes[1] still wants its final RAA
3426                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3427         } else if messages_delivered == 5 {
3428                 // Everything was delivered...
3429                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3430         }
3431
3432         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3433         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3434         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3435
3436         // Channel should still work fine...
3437         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3438         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3439 }
3440
3441 #[test]
3442 fn test_drop_messages_peer_disconnect_a() {
3443         do_test_drop_messages_peer_disconnect(0);
3444         do_test_drop_messages_peer_disconnect(1);
3445         do_test_drop_messages_peer_disconnect(2);
3446         do_test_drop_messages_peer_disconnect(3);
3447 }
3448
3449 #[test]
3450 fn test_drop_messages_peer_disconnect_b() {
3451         do_test_drop_messages_peer_disconnect(4);
3452         do_test_drop_messages_peer_disconnect(5);
3453         do_test_drop_messages_peer_disconnect(6);
3454 }
3455
3456 #[test]
3457 fn test_funding_peer_disconnect() {
3458         // Test that we can lock in our funding tx while disconnected
3459         let chanmon_cfgs = create_chanmon_cfgs(2);
3460         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3461         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3462         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3463         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3464
3465         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3466         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3467
3468         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3469         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3470         assert_eq!(events_1.len(), 1);
3471         match events_1[0] {
3472                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3473                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3474                 },
3475                 _ => panic!("Unexpected event"),
3476         }
3477
3478         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3479
3480         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3481         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3482
3483         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3484         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3485         assert_eq!(events_2.len(), 2);
3486         let funding_locked = match events_2[0] {
3487                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3488                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3489                         msg.clone()
3490                 },
3491                 _ => panic!("Unexpected event"),
3492         };
3493         let bs_announcement_sigs = match events_2[1] {
3494                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3495                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3496                         msg.clone()
3497                 },
3498                 _ => panic!("Unexpected event"),
3499         };
3500
3501         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3502
3503         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3504         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3505         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3506         assert_eq!(events_3.len(), 2);
3507         let as_announcement_sigs = match events_3[0] {
3508                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3509                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3510                         msg.clone()
3511                 },
3512                 _ => panic!("Unexpected event"),
3513         };
3514         let (as_announcement, as_update) = match events_3[1] {
3515                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3516                         (msg.clone(), update_msg.clone())
3517                 },
3518                 _ => panic!("Unexpected event"),
3519         };
3520
3521         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3522         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3523         assert_eq!(events_4.len(), 1);
3524         let (_, bs_update) = match events_4[0] {
3525                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3526                         (msg.clone(), update_msg.clone())
3527                 },
3528                 _ => panic!("Unexpected event"),
3529         };
3530
3531         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3532         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3533         nodes[0].router.handle_channel_update(&as_update).unwrap();
3534
3535         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3536         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3537         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3538 }
3539
3540 #[test]
3541 fn test_drop_messages_peer_disconnect_dual_htlc() {
3542         // Test that we can handle reconnecting when both sides of a channel have pending
3543         // commitment_updates when we disconnect.
3544         let chanmon_cfgs = create_chanmon_cfgs(2);
3545         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3546         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3547         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3548         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3549
3550         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3551
3552         // Now try to send a second payment which will fail to send
3553         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3554         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3555
3556         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3557         check_added_monitors!(nodes[0], 1);
3558
3559         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3560         assert_eq!(events_1.len(), 1);
3561         match events_1[0] {
3562                 MessageSendEvent::UpdateHTLCs { .. } => {},
3563                 _ => panic!("Unexpected event"),
3564         }
3565
3566         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3567         check_added_monitors!(nodes[1], 1);
3568
3569         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3570         assert_eq!(events_2.len(), 1);
3571         match events_2[0] {
3572                 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 } } => {
3573                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3574                         assert!(update_add_htlcs.is_empty());
3575                         assert_eq!(update_fulfill_htlcs.len(), 1);
3576                         assert!(update_fail_htlcs.is_empty());
3577                         assert!(update_fail_malformed_htlcs.is_empty());
3578                         assert!(update_fee.is_none());
3579
3580                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3581                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3582                         assert_eq!(events_3.len(), 1);
3583                         match events_3[0] {
3584                                 Event::PaymentSent { ref payment_preimage } => {
3585                                         assert_eq!(*payment_preimage, payment_preimage_1);
3586                                 },
3587                                 _ => panic!("Unexpected event"),
3588                         }
3589
3590                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3591                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3592                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3593                         check_added_monitors!(nodes[0], 1);
3594                 },
3595                 _ => panic!("Unexpected event"),
3596         }
3597
3598         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3599         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3600
3601         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3602         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3603         assert_eq!(reestablish_1.len(), 1);
3604         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3605         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3606         assert_eq!(reestablish_2.len(), 1);
3607
3608         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3609         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3610         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3611         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3612
3613         assert!(as_resp.0.is_none());
3614         assert!(bs_resp.0.is_none());
3615
3616         assert!(bs_resp.1.is_none());
3617         assert!(bs_resp.2.is_none());
3618
3619         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3620
3621         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3622         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3623         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3624         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3625         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3626         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3627         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3628         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3629         // No commitment_signed so get_event_msg's assert(len == 1) passes
3630         check_added_monitors!(nodes[1], 1);
3631
3632         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3633         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3634         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3635         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3636         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3637         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3638         assert!(bs_second_commitment_signed.update_fee.is_none());
3639         check_added_monitors!(nodes[1], 1);
3640
3641         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3642         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3643         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3644         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3645         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3646         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3647         assert!(as_commitment_signed.update_fee.is_none());
3648         check_added_monitors!(nodes[0], 1);
3649
3650         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3651         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3652         // No commitment_signed so get_event_msg's assert(len == 1) passes
3653         check_added_monitors!(nodes[0], 1);
3654
3655         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3656         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3657         // No commitment_signed so get_event_msg's assert(len == 1) passes
3658         check_added_monitors!(nodes[1], 1);
3659
3660         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3661         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3662         check_added_monitors!(nodes[1], 1);
3663
3664         expect_pending_htlcs_forwardable!(nodes[1]);
3665
3666         let events_5 = nodes[1].node.get_and_clear_pending_events();
3667         assert_eq!(events_5.len(), 1);
3668         match events_5[0] {
3669                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3670                         assert_eq!(payment_hash_2, *payment_hash);
3671                         assert_eq!(*payment_secret, None);
3672                 },
3673                 _ => panic!("Unexpected event"),
3674         }
3675
3676         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3677         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3678         check_added_monitors!(nodes[0], 1);
3679
3680         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3681 }
3682
3683 #[test]
3684 fn test_invalid_channel_announcement() {
3685         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3686         let secp_ctx = Secp256k1::new();
3687         let chanmon_cfgs = create_chanmon_cfgs(2);
3688         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3689         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3690         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3691
3692         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3693
3694         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3695         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3696         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3697         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3698
3699         nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3700
3701         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3702         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3703
3704         let as_network_key = nodes[0].node.get_our_node_id();
3705         let bs_network_key = nodes[1].node.get_our_node_id();
3706
3707         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3708
3709         let mut chan_announcement;
3710
3711         macro_rules! dummy_unsigned_msg {
3712                 () => {
3713                         msgs::UnsignedChannelAnnouncement {
3714                                 features: ChannelFeatures::supported(),
3715                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3716                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3717                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3718                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3719                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3720                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3721                                 excess_data: Vec::new(),
3722                         };
3723                 }
3724         }
3725
3726         macro_rules! sign_msg {
3727                 ($unsigned_msg: expr) => {
3728                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3729                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key());
3730                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key());
3731                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3732                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3733                         chan_announcement = msgs::ChannelAnnouncement {
3734                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3735                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3736                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3737                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3738                                 contents: $unsigned_msg
3739                         }
3740                 }
3741         }
3742
3743         let unsigned_msg = dummy_unsigned_msg!();
3744         sign_msg!(unsigned_msg);
3745         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3746         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 } );
3747
3748         // Configured with Network::Testnet
3749         let mut unsigned_msg = dummy_unsigned_msg!();
3750         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3751         sign_msg!(unsigned_msg);
3752         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3753
3754         let mut unsigned_msg = dummy_unsigned_msg!();
3755         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3756         sign_msg!(unsigned_msg);
3757         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3758 }
3759
3760 #[test]
3761 fn test_no_txn_manager_serialize_deserialize() {
3762         let chanmon_cfgs = create_chanmon_cfgs(2);
3763         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3764         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3765         let fee_estimator: test_utils::TestFeeEstimator;
3766         let new_chan_monitor: test_utils::TestChannelMonitor;
3767         let keys_manager: test_utils::TestKeysInterface;
3768         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3769         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3770
3771         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3772
3773         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3774
3775         let nodes_0_serialized = nodes[0].node.encode();
3776         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3777         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3778
3779         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3780         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);
3781         nodes[0].chan_monitor = &new_chan_monitor;
3782         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3783         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3784         assert!(chan_0_monitor_read.is_empty());
3785
3786         let mut nodes_0_read = &nodes_0_serialized[..];
3787         let config = UserConfig::default();
3788         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3789         let (_, nodes_0_deserialized_tmp) = {
3790                 let mut channel_monitors = HashMap::new();
3791                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3792                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3793                         default_config: config,
3794                         keys_manager: &keys_manager,
3795                         fee_estimator: &fee_estimator,
3796                         monitor: nodes[0].chan_monitor,
3797                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3798                         logger: Arc::new(test_utils::TestLogger::new()),
3799                         channel_monitors: &mut channel_monitors,
3800                 }).unwrap()
3801         };
3802         nodes_0_deserialized = nodes_0_deserialized_tmp;
3803         assert!(nodes_0_read.is_empty());
3804
3805         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3806         nodes[0].node = &nodes_0_deserialized;
3807         nodes[0].block_notifier.register_listener(nodes[0].node);
3808         assert_eq!(nodes[0].node.list_channels().len(), 1);
3809         check_added_monitors!(nodes[0], 1);
3810
3811         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3812         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3813         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3814         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3815
3816         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3817         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3818         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3819         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3820
3821         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3822         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3823         for node in nodes.iter() {
3824                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3825                 node.router.handle_channel_update(&as_update).unwrap();
3826                 node.router.handle_channel_update(&bs_update).unwrap();
3827         }
3828
3829         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3830 }
3831
3832 #[test]
3833 fn test_simple_manager_serialize_deserialize() {
3834         let chanmon_cfgs = create_chanmon_cfgs(2);
3835         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3836         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3837         let fee_estimator: test_utils::TestFeeEstimator;
3838         let new_chan_monitor: test_utils::TestChannelMonitor;
3839         let keys_manager: test_utils::TestKeysInterface;
3840         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3841         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3842         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3843
3844         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3845         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3846
3847         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3848
3849         let nodes_0_serialized = nodes[0].node.encode();
3850         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3851         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3852
3853         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3854         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);
3855         nodes[0].chan_monitor = &new_chan_monitor;
3856         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3857         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3858         assert!(chan_0_monitor_read.is_empty());
3859
3860         let mut nodes_0_read = &nodes_0_serialized[..];
3861         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3862         let (_, nodes_0_deserialized_tmp) = {
3863                 let mut channel_monitors = HashMap::new();
3864                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3865                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3866                         default_config: UserConfig::default(),
3867                         keys_manager: &keys_manager,
3868                         fee_estimator: &fee_estimator,
3869                         monitor: nodes[0].chan_monitor,
3870                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3871                         logger: Arc::new(test_utils::TestLogger::new()),
3872                         channel_monitors: &mut channel_monitors,
3873                 }).unwrap()
3874         };
3875         nodes_0_deserialized = nodes_0_deserialized_tmp;
3876         assert!(nodes_0_read.is_empty());
3877
3878         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3879         nodes[0].node = &nodes_0_deserialized;
3880         check_added_monitors!(nodes[0], 1);
3881
3882         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3883
3884         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3885         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3886 }
3887
3888 #[test]
3889 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3890         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3891         let chanmon_cfgs = create_chanmon_cfgs(4);
3892         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3893         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3894         let fee_estimator: test_utils::TestFeeEstimator;
3895         let new_chan_monitor: test_utils::TestChannelMonitor;
3896         let keys_manager: test_utils::TestKeysInterface;
3897         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3898         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3899         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3900         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3901         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3902
3903         let mut node_0_stale_monitors_serialized = Vec::new();
3904         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3905                 let mut writer = test_utils::TestVecWriter(Vec::new());
3906                 monitor.1.write_for_disk(&mut writer).unwrap();
3907                 node_0_stale_monitors_serialized.push(writer.0);
3908         }
3909
3910         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3911
3912         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3913         let nodes_0_serialized = nodes[0].node.encode();
3914
3915         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3916         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3917         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3918         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3919
3920         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3921         // nodes[3])
3922         let mut node_0_monitors_serialized = Vec::new();
3923         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3924                 let mut writer = test_utils::TestVecWriter(Vec::new());
3925                 monitor.1.write_for_disk(&mut writer).unwrap();
3926                 node_0_monitors_serialized.push(writer.0);
3927         }
3928
3929         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3930         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);
3931         nodes[0].chan_monitor = &new_chan_monitor;
3932
3933         let mut node_0_stale_monitors = Vec::new();
3934         for serialized in node_0_stale_monitors_serialized.iter() {
3935                 let mut read = &serialized[..];
3936                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3937                 assert!(read.is_empty());
3938                 node_0_stale_monitors.push(monitor);
3939         }
3940
3941         let mut node_0_monitors = Vec::new();
3942         for serialized in node_0_monitors_serialized.iter() {
3943                 let mut read = &serialized[..];
3944                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3945                 assert!(read.is_empty());
3946                 node_0_monitors.push(monitor);
3947         }
3948
3949         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3950
3951         let mut nodes_0_read = &nodes_0_serialized[..];
3952         if let Err(msgs::DecodeError::InvalidValue) =
3953                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3954                 default_config: UserConfig::default(),
3955                 keys_manager: &keys_manager,
3956                 fee_estimator: &fee_estimator,
3957                 monitor: nodes[0].chan_monitor,
3958                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3959                 logger: Arc::new(test_utils::TestLogger::new()),
3960                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3961         }) { } else {
3962                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
3963         };
3964
3965         let mut nodes_0_read = &nodes_0_serialized[..];
3966         let (_, nodes_0_deserialized_tmp) =
3967                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3968                 default_config: UserConfig::default(),
3969                 keys_manager: &keys_manager,
3970                 fee_estimator: &fee_estimator,
3971                 monitor: nodes[0].chan_monitor,
3972                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3973                 logger: Arc::new(test_utils::TestLogger::new()),
3974                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3975         }).unwrap();
3976         nodes_0_deserialized = nodes_0_deserialized_tmp;
3977         assert!(nodes_0_read.is_empty());
3978
3979         { // Channel close should result in a commitment tx and an HTLC tx
3980                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3981                 assert_eq!(txn.len(), 2);
3982                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3983                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3984         }
3985
3986         for monitor in node_0_monitors.drain(..) {
3987                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3988                 check_added_monitors!(nodes[0], 1);
3989         }
3990         nodes[0].node = &nodes_0_deserialized;
3991
3992         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3993         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3994         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3995         //... and we can even still claim the payment!
3996         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3997
3998         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3999         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
4000         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
4001         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
4002         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4003         assert_eq!(msg_events.len(), 1);
4004         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
4005                 match action {
4006                         &ErrorAction::SendErrorMessage { ref msg } => {
4007                                 assert_eq!(msg.channel_id, channel_id);
4008                         },
4009                         _ => panic!("Unexpected event!"),
4010                 }
4011         }
4012 }
4013
4014 macro_rules! check_spendable_outputs {
4015         ($node: expr, $der_idx: expr) => {
4016                 {
4017                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
4018                         let mut txn = Vec::new();
4019                         for event in events {
4020                                 match event {
4021                                         Event::SpendableOutputs { ref outputs } => {
4022                                                 for outp in outputs {
4023                                                         match *outp {
4024                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
4025                                                                         let input = TxIn {
4026                                                                                 previous_output: outpoint.clone(),
4027                                                                                 script_sig: Script::new(),
4028                                                                                 sequence: 0,
4029                                                                                 witness: Vec::new(),
4030                                                                         };
4031                                                                         let outp = TxOut {
4032                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4033                                                                                 value: output.value,
4034                                                                         };
4035                                                                         let mut spend_tx = Transaction {
4036                                                                                 version: 2,
4037                                                                                 lock_time: 0,
4038                                                                                 input: vec![input],
4039                                                                                 output: vec![outp],
4040                                                                         };
4041                                                                         let secp_ctx = Secp256k1::new();
4042                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
4043                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4044                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4045                                                                         let remotesig = secp_ctx.sign(&sighash, key);
4046                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4047                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4048                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4049                                                                         txn.push(spend_tx);
4050                                                                 },
4051                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
4052                                                                         let input = TxIn {
4053                                                                                 previous_output: outpoint.clone(),
4054                                                                                 script_sig: Script::new(),
4055                                                                                 sequence: *to_self_delay as u32,
4056                                                                                 witness: Vec::new(),
4057                                                                         };
4058                                                                         let outp = TxOut {
4059                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4060                                                                                 value: output.value,
4061                                                                         };
4062                                                                         let mut spend_tx = Transaction {
4063                                                                                 version: 2,
4064                                                                                 lock_time: 0,
4065                                                                                 input: vec![input],
4066                                                                                 output: vec![outp],
4067                                                                         };
4068                                                                         let secp_ctx = Secp256k1::new();
4069                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
4070                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
4071                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
4072                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4073                                                                         spend_tx.input[0].witness.push(vec!());
4074                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4075                                                                         txn.push(spend_tx);
4076                                                                 },
4077                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4078                                                                         let secp_ctx = Secp256k1::new();
4079                                                                         let input = TxIn {
4080                                                                                 previous_output: outpoint.clone(),
4081                                                                                 script_sig: Script::new(),
4082                                                                                 sequence: 0,
4083                                                                                 witness: Vec::new(),
4084                                                                         };
4085                                                                         let outp = TxOut {
4086                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4087                                                                                 value: output.value,
4088                                                                         };
4089                                                                         let mut spend_tx = Transaction {
4090                                                                                 version: 2,
4091                                                                                 lock_time: 0,
4092                                                                                 input: vec![input],
4093                                                                                 output: vec![outp.clone()],
4094                                                                         };
4095                                                                         let secret = {
4096                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4097                                                                                         Ok(master_key) => {
4098                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4099                                                                                                         Ok(key) => key,
4100                                                                                                         Err(_) => panic!("Your RNG is busted"),
4101                                                                                                 }
4102                                                                                         }
4103                                                                                         Err(_) => panic!("Your rng is busted"),
4104                                                                                 }
4105                                                                         };
4106                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4107                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4108                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4109                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4110                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4111                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4112                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4113                                                                         txn.push(spend_tx);
4114                                                                 },
4115                                                         }
4116                                                 }
4117                                         },
4118                                         _ => panic!("Unexpected event"),
4119                                 };
4120                         }
4121                         txn
4122                 }
4123         }
4124 }
4125
4126 #[test]
4127 fn test_claim_sizeable_push_msat() {
4128         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4129         let chanmon_cfgs = create_chanmon_cfgs(2);
4130         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4131         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4132         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4133
4134         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4135         nodes[1].node.force_close_channel(&chan.2);
4136         check_closed_broadcast!(nodes[1], false);
4137         check_added_monitors!(nodes[1], 1);
4138         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4139         assert_eq!(node_txn.len(), 1);
4140         check_spends!(node_txn[0], chan.3);
4141         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
4142
4143         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4144         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4145         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4146
4147         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4148         assert_eq!(spend_txn.len(), 1);
4149         check_spends!(spend_txn[0], node_txn[0]);
4150 }
4151
4152 #[test]
4153 fn test_claim_on_remote_sizeable_push_msat() {
4154         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4155         // to_remote output is encumbered by a P2WPKH
4156         let chanmon_cfgs = create_chanmon_cfgs(2);
4157         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4158         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4159         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4160
4161         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4162         nodes[0].node.force_close_channel(&chan.2);
4163         check_closed_broadcast!(nodes[0], false);
4164         check_added_monitors!(nodes[0], 1);
4165
4166         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4167         assert_eq!(node_txn.len(), 1);
4168         check_spends!(node_txn[0], chan.3);
4169         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
4170
4171         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4172         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4173         check_closed_broadcast!(nodes[1], false);
4174         check_added_monitors!(nodes[1], 1);
4175         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4176
4177         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4178         assert_eq!(spend_txn.len(), 2);
4179         assert_eq!(spend_txn[0], spend_txn[1]);
4180         check_spends!(spend_txn[0], node_txn[0]);
4181 }
4182
4183 #[test]
4184 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4185         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4186         // to_remote output is encumbered by a P2WPKH
4187
4188         let chanmon_cfgs = create_chanmon_cfgs(2);
4189         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4190         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4191         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4192
4193         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
4194         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4195         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4196         assert_eq!(revoked_local_txn[0].input.len(), 1);
4197         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4198
4199         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4200         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4201         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4202         check_closed_broadcast!(nodes[1], false);
4203         check_added_monitors!(nodes[1], 1);
4204
4205         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4206         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4207         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4208         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4209
4210         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4211         assert_eq!(spend_txn.len(), 3);
4212         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4213         check_spends!(spend_txn[0], revoked_local_txn[0]);
4214         check_spends!(spend_txn[2], node_txn[0]);
4215 }
4216
4217 #[test]
4218 fn test_static_spendable_outputs_preimage_tx() {
4219         let chanmon_cfgs = create_chanmon_cfgs(2);
4220         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4221         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4222         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4223
4224         // Create some initial channels
4225         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4226
4227         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4228
4229         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4230         assert_eq!(commitment_tx[0].input.len(), 1);
4231         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4232
4233         // Settle A's commitment tx on B's chain
4234         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4235         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4236         check_added_monitors!(nodes[1], 1);
4237         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4238         check_added_monitors!(nodes[1], 1);
4239         let events = nodes[1].node.get_and_clear_pending_msg_events();
4240         match events[0] {
4241                 MessageSendEvent::UpdateHTLCs { .. } => {},
4242                 _ => panic!("Unexpected event"),
4243         }
4244         match events[1] {
4245                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4246                 _ => panic!("Unexepected event"),
4247         }
4248
4249         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4250         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4251         assert_eq!(node_txn.len(), 3);
4252         check_spends!(node_txn[0], commitment_tx[0]);
4253         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4254         check_spends!(node_txn[1], chan_1.3);
4255         check_spends!(node_txn[2], node_txn[1]);
4256
4257         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4258         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4259         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4260
4261         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4262         assert_eq!(spend_txn.len(), 1);
4263         check_spends!(spend_txn[0], node_txn[0]);
4264 }
4265
4266 #[test]
4267 fn test_static_spendable_outputs_timeout_tx() {
4268         let chanmon_cfgs = create_chanmon_cfgs(2);
4269         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4270         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4271         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4272
4273         // Create some initial channels
4274         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4275
4276         // Rebalance the network a bit by relaying one payment through all the channels ...
4277         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4278
4279         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4280
4281         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4282         assert_eq!(commitment_tx[0].input.len(), 1);
4283         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4284
4285         // Settle A's commitment tx on B' chain
4286         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4287         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4288         check_added_monitors!(nodes[1], 1);
4289         let events = nodes[1].node.get_and_clear_pending_msg_events();
4290         match events[0] {
4291                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4292                 _ => panic!("Unexpected event"),
4293         }
4294
4295         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4296         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4297         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4298         check_spends!(node_txn[0],  commitment_tx[0].clone());
4299         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4300         check_spends!(node_txn[1], chan_1.3.clone());
4301         check_spends!(node_txn[2], node_txn[1]);
4302
4303         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4304         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4305         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4306         let events = nodes[1].node.get_and_clear_pending_events();
4307         assert_eq!(events.len(), 1);
4308         match events[0] {
4309                 Event::PaymentFailed { payment_hash, .. } => {
4310                         assert_eq!(payment_hash, our_payment_hash);
4311                 },
4312                 _ => panic!("Unexpected event"),
4313         }
4314
4315         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4316         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4317         check_spends!(spend_txn[2], node_txn[0].clone());
4318 }
4319
4320 #[test]
4321 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4322         let chanmon_cfgs = create_chanmon_cfgs(2);
4323         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4324         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4325         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4326
4327         // Create some initial channels
4328         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4329
4330         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4331         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4332         assert_eq!(revoked_local_txn[0].input.len(), 1);
4333         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4334
4335         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4336
4337         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4338         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4339         check_closed_broadcast!(nodes[1], false);
4340         check_added_monitors!(nodes[1], 1);
4341
4342         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4343         assert_eq!(node_txn.len(), 2);
4344         assert_eq!(node_txn[0].input.len(), 2);
4345         check_spends!(node_txn[0], revoked_local_txn[0]);
4346
4347         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4348         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4349         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4350
4351         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4352         assert_eq!(spend_txn.len(), 1);
4353         check_spends!(spend_txn[0], node_txn[0]);
4354 }
4355
4356 #[test]
4357 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4358         let chanmon_cfgs = create_chanmon_cfgs(2);
4359         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4360         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4361         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4362
4363         // Create some initial channels
4364         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4365
4366         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4367         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4368         assert_eq!(revoked_local_txn[0].input.len(), 1);
4369         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4370
4371         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4372
4373         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4374         // A will generate HTLC-Timeout from revoked commitment tx
4375         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4376         check_closed_broadcast!(nodes[0], false);
4377         check_added_monitors!(nodes[0], 1);
4378
4379         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4380         assert_eq!(revoked_htlc_txn.len(), 3);
4381         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4382         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4383         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4384         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4385         check_spends!(revoked_htlc_txn[1], chan_1.3);
4386
4387         // B will generate justice tx from A's revoked commitment/HTLC tx
4388         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4389         check_closed_broadcast!(nodes[1], false);
4390         check_added_monitors!(nodes[1], 1);
4391
4392         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4393         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
4394         assert_eq!(node_txn[0].input.len(), 2);
4395         check_spends!(node_txn[0], revoked_local_txn[0]);
4396         check_spends!(node_txn[1], chan_1.3);
4397         assert_eq!(node_txn[2].input.len(), 1);
4398         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4399         assert_eq!(node_txn[3].input.len(), 1);
4400         check_spends!(node_txn[3], revoked_local_txn[0]);
4401
4402         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4403         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4404         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4405
4406         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4407         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4408         assert_eq!(spend_txn.len(), 2);
4409         check_spends!(spend_txn[0], node_txn[0]);
4410         check_spends!(spend_txn[1], node_txn[2]);
4411 }
4412
4413 #[test]
4414 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4415         let chanmon_cfgs = create_chanmon_cfgs(2);
4416         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4417         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4418         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4419
4420         // Create some initial channels
4421         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4422
4423         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4424         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4425         assert_eq!(revoked_local_txn[0].input.len(), 1);
4426         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4427
4428         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4429
4430         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4431         // B will generate HTLC-Success from revoked commitment tx
4432         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4433         check_closed_broadcast!(nodes[1], false);
4434         check_added_monitors!(nodes[1], 1);
4435         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4436
4437         assert_eq!(revoked_htlc_txn.len(), 3);
4438         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4439         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4440         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4441         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4442
4443         // A will generate justice tx from B's revoked commitment/HTLC tx
4444         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4445         check_closed_broadcast!(nodes[0], false);
4446         check_added_monitors!(nodes[0], 1);
4447
4448         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4449         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4450         assert_eq!(node_txn[2].input.len(), 1);
4451         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4452
4453         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4454         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4455         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4456
4457         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4458         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4459         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
4460         assert_eq!(spend_txn[0], spend_txn[1]);
4461         assert_eq!(spend_txn[0], spend_txn[2]);
4462         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4463         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
4464         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
4465 }
4466
4467 #[test]
4468 fn test_onchain_to_onchain_claim() {
4469         // Test that in case of channel closure, we detect the state of output thanks to
4470         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4471         // First, have C claim an HTLC against its own latest commitment transaction.
4472         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4473         // channel.
4474         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4475         // gets broadcast.
4476
4477         let chanmon_cfgs = create_chanmon_cfgs(3);
4478         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4479         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4480         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4481
4482         // Create some initial channels
4483         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4484         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4485
4486         // Rebalance the network a bit by relaying one payment through all the channels ...
4487         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4488         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4489
4490         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4491         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4492         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4493         check_spends!(commitment_tx[0], chan_2.3);
4494         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
4495         check_added_monitors!(nodes[2], 1);
4496         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4497         assert!(updates.update_add_htlcs.is_empty());
4498         assert!(updates.update_fail_htlcs.is_empty());
4499         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4500         assert!(updates.update_fail_malformed_htlcs.is_empty());
4501
4502         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4503         check_closed_broadcast!(nodes[2], false);
4504         check_added_monitors!(nodes[2], 1);
4505
4506         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4507         assert_eq!(c_txn.len(), 4);
4508         assert_eq!(c_txn[0], c_txn[2]);
4509         assert_eq!(c_txn[0], c_txn[3]);
4510         assert_eq!(commitment_tx[0], c_txn[1]);
4511         check_spends!(c_txn[1], chan_2.3);
4512         check_spends!(c_txn[2], c_txn[1]);
4513         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4514         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4515         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4516         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4517
4518         // 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
4519         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4520         {
4521                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4522                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4523                 assert_eq!(b_txn.len(), 3);
4524                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4525                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4526                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4527                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4528                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4529                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4530                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4531                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4532                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4533                 b_txn.clear();
4534         }
4535         check_added_monitors!(nodes[1], 1);
4536         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4537         check_added_monitors!(nodes[1], 1);
4538         match msg_events[0] {
4539                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4540                 _ => panic!("Unexpected event"),
4541         }
4542         match msg_events[1] {
4543                 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, .. } } => {
4544                         assert!(update_add_htlcs.is_empty());
4545                         assert!(update_fail_htlcs.is_empty());
4546                         assert_eq!(update_fulfill_htlcs.len(), 1);
4547                         assert!(update_fail_malformed_htlcs.is_empty());
4548                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4549                 },
4550                 _ => panic!("Unexpected event"),
4551         };
4552         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4553         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4554         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4555         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4556         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4557         assert_eq!(b_txn.len(), 3);
4558         check_spends!(b_txn[1], chan_1.3);
4559         check_spends!(b_txn[2], b_txn[1]);
4560         check_spends!(b_txn[0], commitment_tx[0]);
4561         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4562         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4563         assert_eq!(b_txn[0].lock_time, 0); // Success tx
4564
4565         check_closed_broadcast!(nodes[1], false);
4566         check_added_monitors!(nodes[1], 1);
4567 }
4568
4569 #[test]
4570 fn test_duplicate_payment_hash_one_failure_one_success() {
4571         // Topology : A --> B --> C
4572         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4573         let chanmon_cfgs = create_chanmon_cfgs(3);
4574         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4575         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4576         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4577
4578         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4579         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4580
4581         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4582         *nodes[0].network_payment_count.borrow_mut() -= 1;
4583         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4584
4585         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
4586         assert_eq!(commitment_txn[0].input.len(), 1);
4587         check_spends!(commitment_txn[0], chan_2.3);
4588
4589         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4590         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4591         check_closed_broadcast!(nodes[1], false);
4592         check_added_monitors!(nodes[1], 1);
4593
4594         let htlc_timeout_tx;
4595         { // Extract one of the two HTLC-Timeout transaction
4596                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4597                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
4598                 assert_eq!(node_txn.len(), 5);
4599                 check_spends!(node_txn[0], commitment_txn[0]);
4600                 assert_eq!(node_txn[0].input.len(), 1);
4601                 check_spends!(node_txn[1], commitment_txn[0]);
4602                 assert_eq!(node_txn[1].input.len(), 1);
4603                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4604                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4605                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4606                 check_spends!(node_txn[2], chan_2.3);
4607                 check_spends!(node_txn[3], node_txn[2]);
4608                 check_spends!(node_txn[4], node_txn[2]);
4609                 htlc_timeout_tx = node_txn[1].clone();
4610         }
4611
4612         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
4613         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4614         check_added_monitors!(nodes[2], 3);
4615         let events = nodes[2].node.get_and_clear_pending_msg_events();
4616         match events[0] {
4617                 MessageSendEvent::UpdateHTLCs { .. } => {},
4618                 _ => panic!("Unexpected event"),
4619         }
4620         match events[1] {
4621                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4622                 _ => panic!("Unexepected event"),
4623         }
4624         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4625         assert_eq!(htlc_success_txn.len(), 7);
4626         check_spends!(htlc_success_txn[2], chan_2.3);
4627         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4628         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4629         assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4630         assert_eq!(htlc_success_txn[0].input.len(), 1);
4631         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4632         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4633         assert_eq!(htlc_success_txn[1].input.len(), 1);
4634         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4635         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4636         check_spends!(htlc_success_txn[0], commitment_txn[0]);
4637         check_spends!(htlc_success_txn[1], commitment_txn[0]);
4638
4639         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4640         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4641         expect_pending_htlcs_forwardable!(nodes[1]);
4642         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4643         assert!(htlc_updates.update_add_htlcs.is_empty());
4644         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4645         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4646         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4647         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4648         check_added_monitors!(nodes[1], 1);
4649
4650         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4651         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4652         {
4653                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4654                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4655                 assert_eq!(events.len(), 1);
4656                 match events[0] {
4657                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4658                         },
4659                         _ => { panic!("Unexpected event"); }
4660                 }
4661         }
4662         let events = nodes[0].node.get_and_clear_pending_events();
4663         match events[0] {
4664                 Event::PaymentFailed { ref payment_hash, .. } => {
4665                         assert_eq!(*payment_hash, duplicate_payment_hash);
4666                 }
4667                 _ => panic!("Unexpected event"),
4668         }
4669
4670         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4671         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4672         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4673         assert!(updates.update_add_htlcs.is_empty());
4674         assert!(updates.update_fail_htlcs.is_empty());
4675         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4676         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4677         assert!(updates.update_fail_malformed_htlcs.is_empty());
4678         check_added_monitors!(nodes[1], 1);
4679
4680         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4681         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4682
4683         let events = nodes[0].node.get_and_clear_pending_events();
4684         match events[0] {
4685                 Event::PaymentSent { ref payment_preimage } => {
4686                         assert_eq!(*payment_preimage, our_payment_preimage);
4687                 }
4688                 _ => panic!("Unexpected event"),
4689         }
4690 }
4691
4692 #[test]
4693 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4694         let chanmon_cfgs = create_chanmon_cfgs(2);
4695         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4696         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4697         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4698
4699         // Create some initial channels
4700         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4701
4702         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4703         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4704         assert_eq!(local_txn[0].input.len(), 1);
4705         check_spends!(local_txn[0], chan_1.3);
4706
4707         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4708         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
4709         check_added_monitors!(nodes[1], 1);
4710         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4711         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4712         check_added_monitors!(nodes[1], 1);
4713         let events = nodes[1].node.get_and_clear_pending_msg_events();
4714         match events[0] {
4715                 MessageSendEvent::UpdateHTLCs { .. } => {},
4716                 _ => panic!("Unexpected event"),
4717         }
4718         match events[1] {
4719                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4720                 _ => panic!("Unexepected event"),
4721         }
4722         let node_txn = {
4723                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4724                 assert_eq!(node_txn[0].input.len(), 1);
4725                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4726                 check_spends!(node_txn[0], local_txn[0]);
4727                 vec![node_txn[0].clone(), node_txn[2].clone()]
4728         };
4729
4730         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4731         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
4732         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
4733
4734         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4735         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4736         assert_eq!(spend_txn.len(), 2);
4737         check_spends!(spend_txn[0], node_txn[0]);
4738         check_spends!(spend_txn[1], node_txn[1]);
4739 }
4740
4741 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4742         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4743         // unrevoked commitment transaction.
4744         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4745         // a remote RAA before they could be failed backwards (and combinations thereof).
4746         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4747         // use the same payment hashes.
4748         // Thus, we use a six-node network:
4749         //
4750         // A \         / E
4751         //    - C - D -
4752         // B /         \ F
4753         // And test where C fails back to A/B when D announces its latest commitment transaction
4754         let chanmon_cfgs = create_chanmon_cfgs(6);
4755         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4756         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4757         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4758
4759         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4760         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4761         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4762         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4763         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4764
4765         // Rebalance and check output sanity...
4766         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4767         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4768         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
4769
4770         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4771         // 0th HTLC:
4772         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
4773         // 1st HTLC:
4774         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
4775         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();
4776         // 2nd HTLC:
4777         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
4778         // 3rd HTLC:
4779         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
4780         // 4th HTLC:
4781         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4782         // 5th HTLC:
4783         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4784         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4785         // 6th HTLC:
4786         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4787         // 7th HTLC:
4788         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4789
4790         // 8th HTLC:
4791         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4792         // 9th HTLC:
4793         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();
4794         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
4795
4796         // 10th HTLC:
4797         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
4798         // 11th HTLC:
4799         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4800         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4801
4802         // Double-check that six of the new HTLC were added
4803         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4804         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4805         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
4806         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
4807
4808         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4809         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4810         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
4811         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
4812         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
4813         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
4814         check_added_monitors!(nodes[4], 0);
4815         expect_pending_htlcs_forwardable!(nodes[4]);
4816         check_added_monitors!(nodes[4], 1);
4817
4818         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4819         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4820         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4821         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4822         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4823         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4824
4825         // Fail 3rd below-dust and 7th above-dust HTLCs
4826         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
4827         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
4828         check_added_monitors!(nodes[5], 0);
4829         expect_pending_htlcs_forwardable!(nodes[5]);
4830         check_added_monitors!(nodes[5], 1);
4831
4832         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4833         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4834         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4835         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4836
4837         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4838
4839         expect_pending_htlcs_forwardable!(nodes[3]);
4840         check_added_monitors!(nodes[3], 1);
4841         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4842         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4843         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4844         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4845         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4846         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4847         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4848         if deliver_last_raa {
4849                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4850         } else {
4851                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4852         }
4853
4854         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4855         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4856         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4857         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4858         //
4859         // We now broadcast the latest commitment transaction, which *should* result in failures for
4860         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4861         // the non-broadcast above-dust HTLCs.
4862         //
4863         // Alternatively, we may broadcast the previous commitment transaction, which should only
4864         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4865         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4866
4867         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4868         if announce_latest {
4869                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4870         } else {
4871                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4872         }
4873         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4874         check_closed_broadcast!(nodes[2], false);
4875         expect_pending_htlcs_forwardable!(nodes[2]);
4876         check_added_monitors!(nodes[2], 3);
4877
4878         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4879         assert_eq!(cs_msgs.len(), 2);
4880         let mut a_done = false;
4881         for msg in cs_msgs {
4882                 match msg {
4883                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4884                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4885                                 // should be failed-backwards here.
4886                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4887                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4888                                         for htlc in &updates.update_fail_htlcs {
4889                                                 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 });
4890                                         }
4891                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4892                                         assert!(!a_done);
4893                                         a_done = true;
4894                                         &nodes[0]
4895                                 } else {
4896                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4897                                         for htlc in &updates.update_fail_htlcs {
4898                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4899                                         }
4900                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4901                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4902                                         &nodes[1]
4903                                 };
4904                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4905                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4906                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4907                                 if announce_latest {
4908                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4909                                         if *node_id == nodes[0].node.get_our_node_id() {
4910                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4911                                         }
4912                                 }
4913                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4914                         },
4915                         _ => panic!("Unexpected event"),
4916                 }
4917         }
4918
4919         let as_events = nodes[0].node.get_and_clear_pending_events();
4920         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4921         let mut as_failds = HashSet::new();
4922         for event in as_events.iter() {
4923                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4924                         assert!(as_failds.insert(*payment_hash));
4925                         if *payment_hash != payment_hash_2 {
4926                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4927                         } else {
4928                                 assert!(!rejected_by_dest);
4929                         }
4930                 } else { panic!("Unexpected event"); }
4931         }
4932         assert!(as_failds.contains(&payment_hash_1));
4933         assert!(as_failds.contains(&payment_hash_2));
4934         if announce_latest {
4935                 assert!(as_failds.contains(&payment_hash_3));
4936                 assert!(as_failds.contains(&payment_hash_5));
4937         }
4938         assert!(as_failds.contains(&payment_hash_6));
4939
4940         let bs_events = nodes[1].node.get_and_clear_pending_events();
4941         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4942         let mut bs_failds = HashSet::new();
4943         for event in bs_events.iter() {
4944                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4945                         assert!(bs_failds.insert(*payment_hash));
4946                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4947                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4948                         } else {
4949                                 assert!(!rejected_by_dest);
4950                         }
4951                 } else { panic!("Unexpected event"); }
4952         }
4953         assert!(bs_failds.contains(&payment_hash_1));
4954         assert!(bs_failds.contains(&payment_hash_2));
4955         if announce_latest {
4956                 assert!(bs_failds.contains(&payment_hash_4));
4957         }
4958         assert!(bs_failds.contains(&payment_hash_5));
4959
4960         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4961         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4962         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4963         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4964         // PaymentFailureNetworkUpdates.
4965         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4966         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4967         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4968         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4969         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4970                 match event {
4971                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4972                         _ => panic!("Unexpected event"),
4973                 }
4974         }
4975 }
4976
4977 #[test]
4978 fn test_fail_backwards_latest_remote_announce_a() {
4979         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4980 }
4981
4982 #[test]
4983 fn test_fail_backwards_latest_remote_announce_b() {
4984         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4985 }
4986
4987 #[test]
4988 fn test_fail_backwards_previous_remote_announce() {
4989         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4990         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4991         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4992 }
4993
4994 #[test]
4995 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4996         let chanmon_cfgs = create_chanmon_cfgs(2);
4997         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4998         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4999         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5000
5001         // Create some initial channels
5002         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5003
5004         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
5005         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
5006         assert_eq!(local_txn[0].input.len(), 1);
5007         check_spends!(local_txn[0], chan_1.3);
5008
5009         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
5010         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5011         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
5012         check_closed_broadcast!(nodes[0], false);
5013         check_added_monitors!(nodes[0], 1);
5014
5015         let htlc_timeout = {
5016                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5017                 assert_eq!(node_txn[0].input.len(), 1);
5018                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5019                 check_spends!(node_txn[0], local_txn[0]);
5020                 node_txn[0].clone()
5021         };
5022
5023         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5024         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5025         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5026         let events = nodes[0].node.get_and_clear_pending_events();
5027         assert_eq!(events.len(), 1);
5028         match events[0] {
5029                 Event::PaymentFailed { payment_hash, .. } => {
5030                         assert_eq!(payment_hash, our_payment_hash);
5031                 },
5032                 _ => panic!("Unexpected event"),
5033         }
5034
5035         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5036         let spend_txn = check_spendable_outputs!(nodes[0], 1);
5037         assert_eq!(spend_txn.len(), 3);
5038         assert_eq!(spend_txn[0], spend_txn[1]);
5039         check_spends!(spend_txn[0], local_txn[0]);
5040         check_spends!(spend_txn[2], htlc_timeout);
5041 }
5042
5043 #[test]
5044 fn test_static_output_closing_tx() {
5045         let chanmon_cfgs = create_chanmon_cfgs(2);
5046         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5047         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5048         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5049
5050         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5051
5052         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5053         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5054
5055         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5056         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5057         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5058
5059         let spend_txn = check_spendable_outputs!(nodes[0], 2);
5060         assert_eq!(spend_txn.len(), 1);
5061         check_spends!(spend_txn[0], closing_tx);
5062
5063         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5064         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5065
5066         let spend_txn = check_spendable_outputs!(nodes[1], 2);
5067         assert_eq!(spend_txn.len(), 1);
5068         check_spends!(spend_txn[0], closing_tx);
5069 }
5070
5071 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5072         let chanmon_cfgs = create_chanmon_cfgs(2);
5073         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5074         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5075         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5076         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5077
5078         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5079
5080         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5081         // present in B's local commitment transaction, but none of A's commitment transactions.
5082         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5083         check_added_monitors!(nodes[1], 1);
5084
5085         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5086         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5087         let events = nodes[0].node.get_and_clear_pending_events();
5088         assert_eq!(events.len(), 1);
5089         match events[0] {
5090                 Event::PaymentSent { payment_preimage } => {
5091                         assert_eq!(payment_preimage, our_payment_preimage);
5092                 },
5093                 _ => panic!("Unexpected event"),
5094         }
5095
5096         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5097         check_added_monitors!(nodes[0], 1);
5098         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5099         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5100         check_added_monitors!(nodes[1], 1);
5101
5102         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5103         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5104                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5105                 header.prev_blockhash = header.bitcoin_hash();
5106         }
5107         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5108         check_closed_broadcast!(nodes[1], false);
5109         check_added_monitors!(nodes[1], 1);
5110 }
5111
5112 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5113         let chanmon_cfgs = create_chanmon_cfgs(2);
5114         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5115         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5116         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5117         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5118
5119         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();
5120         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5121         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5122         check_added_monitors!(nodes[0], 1);
5123
5124         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5125
5126         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5127         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5128         // to "time out" the HTLC.
5129
5130         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5131
5132         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5133                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5134                 header.prev_blockhash = header.bitcoin_hash();
5135         }
5136         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5137         check_closed_broadcast!(nodes[0], false);
5138         check_added_monitors!(nodes[0], 1);
5139 }
5140
5141 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5142         let chanmon_cfgs = create_chanmon_cfgs(3);
5143         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5144         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5145         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5146         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5147
5148         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5149         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5150         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5151         // actually revoked.
5152         let htlc_value = if use_dust { 50000 } else { 3000000 };
5153         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5154         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5155         expect_pending_htlcs_forwardable!(nodes[1]);
5156         check_added_monitors!(nodes[1], 1);
5157
5158         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5159         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5160         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5161         check_added_monitors!(nodes[0], 1);
5162         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5163         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5164         check_added_monitors!(nodes[1], 1);
5165         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5166         check_added_monitors!(nodes[1], 1);
5167         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5168
5169         if check_revoke_no_close {
5170                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5171                 check_added_monitors!(nodes[0], 1);
5172         }
5173
5174         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5175         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5176                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5177                 header.prev_blockhash = header.bitcoin_hash();
5178         }
5179         if !check_revoke_no_close {
5180                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5181                 check_closed_broadcast!(nodes[0], false);
5182                 check_added_monitors!(nodes[0], 1);
5183         } else {
5184                 let events = nodes[0].node.get_and_clear_pending_events();
5185                 assert_eq!(events.len(), 1);
5186                 match events[0] {
5187                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
5188                                 assert_eq!(payment_hash, our_payment_hash);
5189                                 assert!(rejected_by_dest);
5190                         },
5191                         _ => panic!("Unexpected event"),
5192                 }
5193         }
5194 }
5195
5196 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5197 // There are only a few cases to test here:
5198 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5199 //    broadcastable commitment transactions result in channel closure,
5200 //  * its included in an unrevoked-but-previous remote commitment transaction,
5201 //  * its included in the latest remote or local commitment transactions.
5202 // We test each of the three possible commitment transactions individually and use both dust and
5203 // non-dust HTLCs.
5204 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5205 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5206 // tested for at least one of the cases in other tests.
5207 #[test]
5208 fn htlc_claim_single_commitment_only_a() {
5209         do_htlc_claim_local_commitment_only(true);
5210         do_htlc_claim_local_commitment_only(false);
5211
5212         do_htlc_claim_current_remote_commitment_only(true);
5213         do_htlc_claim_current_remote_commitment_only(false);
5214 }
5215
5216 #[test]
5217 fn htlc_claim_single_commitment_only_b() {
5218         do_htlc_claim_previous_remote_commitment_only(true, false);
5219         do_htlc_claim_previous_remote_commitment_only(false, false);
5220         do_htlc_claim_previous_remote_commitment_only(true, true);
5221         do_htlc_claim_previous_remote_commitment_only(false, true);
5222 }
5223
5224 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>)
5225         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5226                                 F2: FnMut(),
5227 {
5228         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);
5229 }
5230
5231 // test_case
5232 // 0: node1 fails backward
5233 // 1: final node fails backward
5234 // 2: payment completed but the user rejects the payment
5235 // 3: final node fails backward (but tamper onion payloads from node0)
5236 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5237 // 200: trigger error in the final node and tamper returning fail_htlc
5238 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>)
5239         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5240                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5241                                 F3: FnMut(),
5242 {
5243
5244         // reset block height
5245         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5246         for ix in 0..nodes.len() {
5247                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5248         }
5249
5250         macro_rules! expect_event {
5251                 ($node: expr, $event_type: path) => {{
5252                         let events = $node.node.get_and_clear_pending_events();
5253                         assert_eq!(events.len(), 1);
5254                         match events[0] {
5255                                 $event_type { .. } => {},
5256                                 _ => panic!("Unexpected event"),
5257                         }
5258                 }}
5259         }
5260
5261         macro_rules! expect_htlc_forward {
5262                 ($node: expr) => {{
5263                         expect_event!($node, Event::PendingHTLCsForwardable);
5264                         $node.node.process_pending_htlc_forwards();
5265                 }}
5266         }
5267
5268         // 0 ~~> 2 send payment
5269         nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5270         check_added_monitors!(nodes[0], 1);
5271         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5272         // temper update_add (0 => 1)
5273         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5274         if test_case == 0 || test_case == 3 || test_case == 100 {
5275                 callback_msg(&mut update_add_0);
5276                 callback_node();
5277         }
5278         // 0 => 1 update_add & CS
5279         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5280         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5281
5282         let update_1_0 = match test_case {
5283                 0|100 => { // intermediate node failure; fail backward to 0
5284                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5285                         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));
5286                         update_1_0
5287                 },
5288                 1|2|3|200 => { // final node failure; forwarding to 2
5289                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5290                         // forwarding on 1
5291                         if test_case != 200 {
5292                                 callback_node();
5293                         }
5294                         expect_htlc_forward!(&nodes[1]);
5295
5296                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5297                         check_added_monitors!(&nodes[1], 1);
5298                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5299                         // tamper update_add (1 => 2)
5300                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5301                         if test_case != 3 && test_case != 200 {
5302                                 callback_msg(&mut update_add_1);
5303                         }
5304
5305                         // 1 => 2
5306                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5307                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5308
5309                         if test_case == 2 || test_case == 200 {
5310                                 expect_htlc_forward!(&nodes[2]);
5311                                 expect_event!(&nodes[2], Event::PaymentReceived);
5312                                 callback_node();
5313                                 expect_pending_htlcs_forwardable!(nodes[2]);
5314                         }
5315
5316                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5317                         if test_case == 2 || test_case == 200 {
5318                                 check_added_monitors!(&nodes[2], 1);
5319                         }
5320                         assert!(update_2_1.update_fail_htlcs.len() == 1);
5321
5322                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5323                         if test_case == 200 {
5324                                 callback_fail(&mut fail_msg);
5325                         }
5326
5327                         // 2 => 1
5328                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5329                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5330
5331                         // backward fail on 1
5332                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5333                         assert!(update_1_0.update_fail_htlcs.len() == 1);
5334                         update_1_0
5335                 },
5336                 _ => unreachable!(),
5337         };
5338
5339         // 1 => 0 commitment_signed_dance
5340         if update_1_0.update_fail_htlcs.len() > 0 {
5341                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5342                 if test_case == 100 {
5343                         callback_fail(&mut fail_msg);
5344                 }
5345                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5346         } else {
5347                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5348         };
5349
5350         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5351
5352         let events = nodes[0].node.get_and_clear_pending_events();
5353         assert_eq!(events.len(), 1);
5354         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
5355                 assert_eq!(*rejected_by_dest, !expected_retryable);
5356                 assert_eq!(*error_code, expected_error_code);
5357         } else {
5358                 panic!("Uexpected event");
5359         }
5360
5361         let events = nodes[0].node.get_and_clear_pending_msg_events();
5362         if expected_channel_update.is_some() {
5363                 assert_eq!(events.len(), 1);
5364                 match events[0] {
5365                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5366                                 match update {
5367                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5368                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5369                                                         panic!("channel_update not found!");
5370                                                 }
5371                                         },
5372                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5373                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5374                                                         assert!(*short_channel_id == *expected_short_channel_id);
5375                                                         assert!(*is_permanent == *expected_is_permanent);
5376                                                 } else {
5377                                                         panic!("Unexpected message event");
5378                                                 }
5379                                         },
5380                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5381                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5382                                                         assert!(*node_id == *expected_node_id);
5383                                                         assert!(*is_permanent == *expected_is_permanent);
5384                                                 } else {
5385                                                         panic!("Unexpected message event");
5386                                                 }
5387                                         },
5388                                 }
5389                         },
5390                         _ => panic!("Unexpected message event"),
5391                 }
5392         } else {
5393                 assert_eq!(events.len(), 0);
5394         }
5395 }
5396
5397 impl msgs::ChannelUpdate {
5398         fn dummy() -> msgs::ChannelUpdate {
5399                 use secp256k1::ffi::Signature as FFISignature;
5400                 use secp256k1::Signature;
5401                 msgs::ChannelUpdate {
5402                         signature: Signature::from(FFISignature::new()),
5403                         contents: msgs::UnsignedChannelUpdate {
5404                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5405                                 short_channel_id: 0,
5406                                 timestamp: 0,
5407                                 flags: 0,
5408                                 cltv_expiry_delta: 0,
5409                                 htlc_minimum_msat: 0,
5410                                 fee_base_msat: 0,
5411                                 fee_proportional_millionths: 0,
5412                                 excess_data: vec![],
5413                         }
5414                 }
5415         }
5416 }
5417
5418 struct BogusOnionHopData {
5419         data: Vec<u8>
5420 }
5421 impl BogusOnionHopData {
5422         fn new(orig: msgs::OnionHopData) -> Self {
5423                 Self { data: orig.encode() }
5424         }
5425 }
5426 impl Writeable for BogusOnionHopData {
5427         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5428                 writer.write_all(&self.data[..])
5429         }
5430 }
5431
5432 #[test]
5433 fn test_onion_failure() {
5434         use ln::msgs::ChannelUpdate;
5435         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5436         use secp256k1;
5437
5438         const BADONION: u16 = 0x8000;
5439         const PERM: u16 = 0x4000;
5440         const NODE: u16 = 0x2000;
5441         const UPDATE: u16 = 0x1000;
5442
5443         let chanmon_cfgs = create_chanmon_cfgs(3);
5444         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5445         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5446         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5447         for node in nodes.iter() {
5448                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5449         }
5450         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())];
5451         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5452         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5453         // positve case
5454         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5455
5456         // intermediate node failure
5457         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5458                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5459                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5460                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5461                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5462                 let mut new_payloads = Vec::new();
5463                 for payload in onion_payloads.drain(..) {
5464                         new_payloads.push(BogusOnionHopData::new(payload));
5465                 }
5466                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5467                 // describing a length-1 TLV payload, which is obviously bogus.
5468                 new_payloads[0].data[0] = 1;
5469                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5470         }, ||{}, 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
5471
5472         // final node failure
5473         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5474                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5475                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5476                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5477                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5478                 let mut new_payloads = Vec::new();
5479                 for payload in onion_payloads.drain(..) {
5480                         new_payloads.push(BogusOnionHopData::new(payload));
5481                 }
5482                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5483                 // length-1 TLV payload, which is obviously bogus.
5484                 new_payloads[1].data[0] = 1;
5485                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5486         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5487
5488         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5489         // receiving simulated fail messages
5490         // intermediate node failure
5491         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5492                 // trigger error
5493                 msg.amount_msat -= 1;
5494         }, |msg| {
5495                 // and tamper returning error message
5496                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5497                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5498                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5499         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
5500
5501         // final node failure
5502         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5503                 // and tamper returning error message
5504                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5505                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5506                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5507         }, ||{
5508                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5509         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
5510
5511         // intermediate node failure
5512         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5513                 msg.amount_msat -= 1;
5514         }, |msg| {
5515                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5516                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5517                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5518         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5519
5520         // final node failure
5521         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5522                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5523                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5524                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5525         }, ||{
5526                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5527         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5528
5529         // intermediate node failure
5530         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5531                 msg.amount_msat -= 1;
5532         }, |msg| {
5533                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5534                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5535                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5536         }, ||{
5537                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5538         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5539
5540         // final node failure
5541         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5542                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5543                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5544                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5545         }, ||{
5546                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5547         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5548
5549         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5550                 Some(BADONION|PERM|4), None);
5551
5552         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5553                 Some(BADONION|PERM|5), None);
5554
5555         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5556                 Some(BADONION|PERM|6), None);
5557
5558         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5559                 msg.amount_msat -= 1;
5560         }, |msg| {
5561                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5562                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5563                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5564         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5565
5566         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5567                 msg.amount_msat -= 1;
5568         }, |msg| {
5569                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5570                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5571                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5572                 // short_channel_id from the processing node
5573         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5574
5575         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5576                 msg.amount_msat -= 1;
5577         }, |msg| {
5578                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5579                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5580                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5581                 // short_channel_id from the processing node
5582         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5583
5584         let mut bogus_route = route.clone();
5585         bogus_route.paths[0][1].short_channel_id -= 1;
5586         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5587           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
5588
5589         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5590         let mut bogus_route = route.clone();
5591         let route_len = bogus_route.paths[0].len();
5592         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
5593         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5594
5595         //TODO: with new config API, we will be able to generate both valid and
5596         //invalid channel_update cases.
5597         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5598                 msg.amount_msat -= 1;
5599         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5600
5601         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5602                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5603                 msg.cltv_expiry -= 1;
5604         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5605
5606         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5607                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5608                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5609
5610                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5611         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5612
5613         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5614                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5615         }, false, Some(PERM|15), None);
5616
5617         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5618                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5619                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5620
5621                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5622         }, || {}, true, Some(17), None);
5623
5624         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5625                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5626                         for f in pending_forwards.iter_mut() {
5627                                 match f {
5628                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5629                                                 forward_info.outgoing_cltv_value += 1,
5630                                         _ => {},
5631                                 }
5632                         }
5633                 }
5634         }, true, Some(18), None);
5635
5636         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5637                 // violate amt_to_forward > msg.amount_msat
5638                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5639                         for f in pending_forwards.iter_mut() {
5640                                 match f {
5641                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5642                                                 forward_info.amt_to_forward -= 1,
5643                                         _ => {},
5644                                 }
5645                         }
5646                 }
5647         }, true, Some(19), None);
5648
5649         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5650                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5651                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5652                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5653         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5654         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5655
5656         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5657                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5658                 let mut route = route.clone();
5659                 let height = 1;
5660                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
5661                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5662                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
5663                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5664                 msg.cltv_expiry = htlc_cltv;
5665                 msg.onion_routing_packet = onion_packet;
5666         }, ||{}, true, Some(21), None);
5667 }
5668
5669 #[test]
5670 #[should_panic]
5671 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5672         let chanmon_cfgs = create_chanmon_cfgs(2);
5673         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5674         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5675         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5676         //Force duplicate channel ids
5677         for node in nodes.iter() {
5678                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5679         }
5680
5681         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5682         let channel_value_satoshis=10000;
5683         let push_msat=10001;
5684         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5685         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5686         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5687
5688         //Create a second channel with a channel_id collision
5689         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5690 }
5691
5692 #[test]
5693 fn bolt2_open_channel_sending_node_checks_part2() {
5694         let chanmon_cfgs = create_chanmon_cfgs(2);
5695         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5696         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5697         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5698
5699         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5700         let channel_value_satoshis=2^24;
5701         let push_msat=10001;
5702         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5703
5704         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5705         let channel_value_satoshis=10000;
5706         // Test when push_msat is equal to 1000 * funding_satoshis.
5707         let push_msat=1000*channel_value_satoshis+1;
5708         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5709
5710         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5711         let channel_value_satoshis=10000;
5712         let push_msat=10001;
5713         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
5714         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5715         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5716
5717         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5718         // 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
5719         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5720
5721         // 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.
5722         assert!(BREAKDOWN_TIMEOUT>0);
5723         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5724
5725         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5726         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5727         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5728
5729         // 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.
5730         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5731         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5732         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5733         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5734         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5735 }
5736
5737 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5738 // 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.
5739 //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.
5740
5741 #[test]
5742 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5743         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5744         let chanmon_cfgs = create_chanmon_cfgs(2);
5745         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5746         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5747         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5748         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5749         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5750         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5751
5752         route.paths[0][0].fee_msat = 100;
5753
5754         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5755                 assert_eq!(err, "Cannot send less than their minimum HTLC value"));
5756         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5757         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5758 }
5759
5760 #[test]
5761 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
5762         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5763         let chanmon_cfgs = create_chanmon_cfgs(2);
5764         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5765         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5766         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5767         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5768         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5769         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5770
5771         route.paths[0][0].fee_msat = 0;
5772
5773         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5774                 assert_eq!(err, "Cannot send 0-msat HTLC"));
5775         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5776         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
5777 }
5778
5779 #[test]
5780 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
5781         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5782         let chanmon_cfgs = create_chanmon_cfgs(2);
5783         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5784         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5785         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5786         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5787         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5788         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5789
5790         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5791         check_added_monitors!(nodes[0], 1);
5792         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5793         updates.update_add_htlcs[0].amount_msat = 0;
5794
5795         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5796         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
5797         check_closed_broadcast!(nodes[1], true).unwrap();
5798         check_added_monitors!(nodes[1], 1);
5799 }
5800
5801 #[test]
5802 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5803         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5804         //It is enforced when constructing a route.
5805         let chanmon_cfgs = create_chanmon_cfgs(2);
5806         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5807         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5808         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5809         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5810         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5811         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5812
5813         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { err },
5814                 assert_eq!(err, "Channel CLTV overflowed?!"));
5815 }
5816
5817 #[test]
5818 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5819         //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.
5820         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5821         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5822         let chanmon_cfgs = create_chanmon_cfgs(2);
5823         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5824         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5825         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5826         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5827         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5828
5829         for i in 0..max_accepted_htlcs {
5830                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5831                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5832                 let payment_event = {
5833                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5834                         check_added_monitors!(nodes[0], 1);
5835
5836                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5837                         assert_eq!(events.len(), 1);
5838                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5839                                 assert_eq!(htlcs[0].htlc_id, i);
5840                         } else {
5841                                 assert!(false);
5842                         }
5843                         SendEvent::from_event(events.remove(0))
5844                 };
5845                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5846                 check_added_monitors!(nodes[1], 0);
5847                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5848
5849                 expect_pending_htlcs_forwardable!(nodes[1]);
5850                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5851         }
5852         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5853         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5854         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5855                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
5856
5857         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5858         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5859 }
5860
5861 #[test]
5862 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5863         //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.
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 channel_value = 100000;
5869         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5870         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5871
5872         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5873
5874         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5875         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5876         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5877                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
5878
5879         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5880         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);
5881
5882         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5883 }
5884
5885 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5886 #[test]
5887 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5888         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5889         let chanmon_cfgs = create_chanmon_cfgs(2);
5890         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5891         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5892         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5893         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5894         let htlc_minimum_msat: u64;
5895         {
5896                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5897                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5898                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5899         }
5900         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5901         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5902         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5903         check_added_monitors!(nodes[0], 1);
5904         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5905         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5906         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5907         assert!(nodes[1].node.list_channels().is_empty());
5908         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5909         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5910         check_added_monitors!(nodes[1], 1);
5911 }
5912
5913 #[test]
5914 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5915         //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
5916         let chanmon_cfgs = create_chanmon_cfgs(2);
5917         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5918         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5919         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5920         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5921
5922         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5923
5924         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5925         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5926         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5927         check_added_monitors!(nodes[0], 1);
5928         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5929
5930         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5931         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5932
5933         assert!(nodes[1].node.list_channels().is_empty());
5934         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5935         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5936         check_added_monitors!(nodes[1], 1);
5937 }
5938
5939 #[test]
5940 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5941         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5942         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5943         let chanmon_cfgs = create_chanmon_cfgs(2);
5944         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5945         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5946         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5947         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5948         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5949         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5950
5951         let session_priv = SecretKey::from_slice(&{
5952                 let mut session_key = [0; 32];
5953                 let mut rng = thread_rng();
5954                 rng.fill_bytes(&mut session_key);
5955                 session_key
5956         }).expect("RNG is bad!");
5957
5958         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5959         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
5960         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
5961         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5962
5963         let mut msg = msgs::UpdateAddHTLC {
5964                 channel_id: chan.2,
5965                 htlc_id: 0,
5966                 amount_msat: 1000,
5967                 payment_hash: our_payment_hash,
5968                 cltv_expiry: htlc_cltv,
5969                 onion_routing_packet: onion_packet.clone(),
5970         };
5971
5972         for i in 0..super::channel::OUR_MAX_HTLCS {
5973                 msg.htlc_id = i as u64;
5974                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5975         }
5976         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5977         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5978
5979         assert!(nodes[1].node.list_channels().is_empty());
5980         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5981         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5982         check_added_monitors!(nodes[1], 1);
5983 }
5984
5985 #[test]
5986 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5987         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5988         let chanmon_cfgs = create_chanmon_cfgs(2);
5989         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5990         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5991         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5992         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5993         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5994         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5995         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5996         check_added_monitors!(nodes[0], 1);
5997         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5998         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5999         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6000
6001         assert!(nodes[1].node.list_channels().is_empty());
6002         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6003         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
6004         check_added_monitors!(nodes[1], 1);
6005 }
6006
6007 #[test]
6008 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6009         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6010         let chanmon_cfgs = create_chanmon_cfgs(2);
6011         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6012         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6013         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6014         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
6015         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
6016         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6017         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6018         check_added_monitors!(nodes[0], 1);
6019         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6020         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6021         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6022
6023         assert!(nodes[1].node.list_channels().is_empty());
6024         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6025         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6026         check_added_monitors!(nodes[1], 1);
6027 }
6028
6029 #[test]
6030 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6031         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6032         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6033         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6034         let chanmon_cfgs = create_chanmon_cfgs(2);
6035         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6036         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6037         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6038         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6039         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6040         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6041         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6042         check_added_monitors!(nodes[0], 1);
6043         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6044         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6045
6046         //Disconnect and Reconnect
6047         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6048         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6049         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6050         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6051         assert_eq!(reestablish_1.len(), 1);
6052         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6053         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6054         assert_eq!(reestablish_2.len(), 1);
6055         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6056         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6057         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6058         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6059
6060         //Resend HTLC
6061         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6062         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6063         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6064         check_added_monitors!(nodes[1], 1);
6065         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6066
6067         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6068
6069         assert!(nodes[1].node.list_channels().is_empty());
6070         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6071         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
6072         check_added_monitors!(nodes[1], 1);
6073 }
6074
6075 #[test]
6076 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6077         //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.
6078
6079         let chanmon_cfgs = create_chanmon_cfgs(2);
6080         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6081         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6082         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6083         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6084
6085         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6086         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6087         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6088         check_added_monitors!(nodes[0], 1);
6089         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6090         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6091
6092         let update_msg = msgs::UpdateFulfillHTLC{
6093                 channel_id: chan.2,
6094                 htlc_id: 0,
6095                 payment_preimage: our_payment_preimage,
6096         };
6097
6098         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6099
6100         assert!(nodes[0].node.list_channels().is_empty());
6101         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6102         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6103         check_added_monitors!(nodes[0], 1);
6104 }
6105
6106 #[test]
6107 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6108         //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.
6109
6110         let chanmon_cfgs = create_chanmon_cfgs(2);
6111         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6112         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6113         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6114         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6115
6116         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6117         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6118         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6119         check_added_monitors!(nodes[0], 1);
6120         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6121         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6122
6123         let update_msg = msgs::UpdateFailHTLC{
6124                 channel_id: chan.2,
6125                 htlc_id: 0,
6126                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6127         };
6128
6129         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6130
6131         assert!(nodes[0].node.list_channels().is_empty());
6132         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6133         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6134         check_added_monitors!(nodes[0], 1);
6135 }
6136
6137 #[test]
6138 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6139         //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.
6140
6141         let chanmon_cfgs = create_chanmon_cfgs(2);
6142         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6143         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6144         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6145         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6146
6147         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6148         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6149         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6150         check_added_monitors!(nodes[0], 1);
6151         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6152         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6153
6154         let update_msg = msgs::UpdateFailMalformedHTLC{
6155                 channel_id: chan.2,
6156                 htlc_id: 0,
6157                 sha256_of_onion: [1; 32],
6158                 failure_code: 0x8000,
6159         };
6160
6161         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6162
6163         assert!(nodes[0].node.list_channels().is_empty());
6164         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6165         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6166         check_added_monitors!(nodes[0], 1);
6167 }
6168
6169 #[test]
6170 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6171         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6172
6173         let chanmon_cfgs = create_chanmon_cfgs(2);
6174         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6175         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6176         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6177         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6178
6179         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6180
6181         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6182         check_added_monitors!(nodes[1], 1);
6183
6184         let events = nodes[1].node.get_and_clear_pending_msg_events();
6185         assert_eq!(events.len(), 1);
6186         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6187                 match events[0] {
6188                         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, .. } } => {
6189                                 assert!(update_add_htlcs.is_empty());
6190                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6191                                 assert!(update_fail_htlcs.is_empty());
6192                                 assert!(update_fail_malformed_htlcs.is_empty());
6193                                 assert!(update_fee.is_none());
6194                                 update_fulfill_htlcs[0].clone()
6195                         },
6196                         _ => panic!("Unexpected event"),
6197                 }
6198         };
6199
6200         update_fulfill_msg.htlc_id = 1;
6201
6202         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6203
6204         assert!(nodes[0].node.list_channels().is_empty());
6205         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6206         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6207         check_added_monitors!(nodes[0], 1);
6208 }
6209
6210 #[test]
6211 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6212         //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.
6213
6214         let chanmon_cfgs = create_chanmon_cfgs(2);
6215         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6216         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6217         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6218         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6219
6220         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6221
6222         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6223         check_added_monitors!(nodes[1], 1);
6224
6225         let events = nodes[1].node.get_and_clear_pending_msg_events();
6226         assert_eq!(events.len(), 1);
6227         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6228                 match events[0] {
6229                         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, .. } } => {
6230                                 assert!(update_add_htlcs.is_empty());
6231                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6232                                 assert!(update_fail_htlcs.is_empty());
6233                                 assert!(update_fail_malformed_htlcs.is_empty());
6234                                 assert!(update_fee.is_none());
6235                                 update_fulfill_htlcs[0].clone()
6236                         },
6237                         _ => panic!("Unexpected event"),
6238                 }
6239         };
6240
6241         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6242
6243         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6244
6245         assert!(nodes[0].node.list_channels().is_empty());
6246         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6247         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
6248         check_added_monitors!(nodes[0], 1);
6249 }
6250
6251 #[test]
6252 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6253         //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.
6254
6255         let chanmon_cfgs = create_chanmon_cfgs(2);
6256         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6257         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6258         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6259         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6260         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6261         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6262         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6263         check_added_monitors!(nodes[0], 1);
6264
6265         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6266         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6267
6268         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6269         check_added_monitors!(nodes[1], 0);
6270         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6271
6272         let events = nodes[1].node.get_and_clear_pending_msg_events();
6273
6274         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6275                 match events[0] {
6276                         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, .. } } => {
6277                                 assert!(update_add_htlcs.is_empty());
6278                                 assert!(update_fulfill_htlcs.is_empty());
6279                                 assert!(update_fail_htlcs.is_empty());
6280                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6281                                 assert!(update_fee.is_none());
6282                                 update_fail_malformed_htlcs[0].clone()
6283                         },
6284                         _ => panic!("Unexpected event"),
6285                 }
6286         };
6287         update_msg.failure_code &= !0x8000;
6288         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6289
6290         assert!(nodes[0].node.list_channels().is_empty());
6291         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6292         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6293         check_added_monitors!(nodes[0], 1);
6294 }
6295
6296 #[test]
6297 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6298         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6299         //    * 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.
6300
6301         let chanmon_cfgs = create_chanmon_cfgs(3);
6302         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6303         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6304         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6305         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6306         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6307
6308         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
6309         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6310
6311         //First hop
6312         let mut payment_event = {
6313                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6314                 check_added_monitors!(nodes[0], 1);
6315                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6316                 assert_eq!(events.len(), 1);
6317                 SendEvent::from_event(events.remove(0))
6318         };
6319         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6320         check_added_monitors!(nodes[1], 0);
6321         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6322         expect_pending_htlcs_forwardable!(nodes[1]);
6323         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6324         assert_eq!(events_2.len(), 1);
6325         check_added_monitors!(nodes[1], 1);
6326         payment_event = SendEvent::from_event(events_2.remove(0));
6327         assert_eq!(payment_event.msgs.len(), 1);
6328
6329         //Second Hop
6330         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6331         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6332         check_added_monitors!(nodes[2], 0);
6333         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6334
6335         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6336         assert_eq!(events_3.len(), 1);
6337         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6338                 match events_3[0] {
6339                         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 } } => {
6340                                 assert!(update_add_htlcs.is_empty());
6341                                 assert!(update_fulfill_htlcs.is_empty());
6342                                 assert!(update_fail_htlcs.is_empty());
6343                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6344                                 assert!(update_fee.is_none());
6345                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6346                         },
6347                         _ => panic!("Unexpected event"),
6348                 }
6349         };
6350
6351         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6352
6353         check_added_monitors!(nodes[1], 0);
6354         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6355         expect_pending_htlcs_forwardable!(nodes[1]);
6356         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6357         assert_eq!(events_4.len(), 1);
6358
6359         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6360         match events_4[0] {
6361                 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, .. } } => {
6362                         assert!(update_add_htlcs.is_empty());
6363                         assert!(update_fulfill_htlcs.is_empty());
6364                         assert_eq!(update_fail_htlcs.len(), 1);
6365                         assert!(update_fail_malformed_htlcs.is_empty());
6366                         assert!(update_fee.is_none());
6367                 },
6368                 _ => panic!("Unexpected event"),
6369         };
6370
6371         check_added_monitors!(nodes[1], 1);
6372 }
6373
6374 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6375         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6376         // 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
6377         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6378
6379         let chanmon_cfgs = create_chanmon_cfgs(2);
6380         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6381         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6382         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6383         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6384
6385         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6386
6387         // We route 2 dust-HTLCs between A and B
6388         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6389         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6390         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6391
6392         // Cache one local commitment tx as previous
6393         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6394
6395         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6396         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
6397         check_added_monitors!(nodes[1], 0);
6398         expect_pending_htlcs_forwardable!(nodes[1]);
6399         check_added_monitors!(nodes[1], 1);
6400
6401         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6402         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6403         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6404         check_added_monitors!(nodes[0], 1);
6405
6406         // Cache one local commitment tx as lastest
6407         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6408
6409         let events = nodes[0].node.get_and_clear_pending_msg_events();
6410         match events[0] {
6411                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6412                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6413                 },
6414                 _ => panic!("Unexpected event"),
6415         }
6416         match events[1] {
6417                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6418                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6419                 },
6420                 _ => panic!("Unexpected event"),
6421         }
6422
6423         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6424         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6425         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6426
6427         if announce_latest {
6428                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6429         } else {
6430                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6431         }
6432
6433         check_closed_broadcast!(nodes[0], false);
6434         check_added_monitors!(nodes[0], 1);
6435
6436         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6437         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
6438         let events = nodes[0].node.get_and_clear_pending_events();
6439         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6440         assert_eq!(events.len(), 2);
6441         let mut first_failed = false;
6442         for event in events {
6443                 match event {
6444                         Event::PaymentFailed { payment_hash, .. } => {
6445                                 if payment_hash == payment_hash_1 {
6446                                         assert!(!first_failed);
6447                                         first_failed = true;
6448                                 } else {
6449                                         assert_eq!(payment_hash, payment_hash_2);
6450                                 }
6451                         }
6452                         _ => panic!("Unexpected event"),
6453                 }
6454         }
6455 }
6456
6457 #[test]
6458 fn test_failure_delay_dust_htlc_local_commitment() {
6459         do_test_failure_delay_dust_htlc_local_commitment(true);
6460         do_test_failure_delay_dust_htlc_local_commitment(false);
6461 }
6462
6463 #[test]
6464 fn test_no_failure_dust_htlc_local_commitment() {
6465         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6466         // prone to error, we test here that a dummy transaction don't fail them.
6467
6468         let chanmon_cfgs = create_chanmon_cfgs(2);
6469         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6470         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6471         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6472         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6473
6474         // Rebalance a bit
6475         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6476
6477         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6478         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6479
6480         // We route 2 dust-HTLCs between A and B
6481         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6482         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6483
6484         // Build a dummy invalid transaction trying to spend a commitment tx
6485         let input = TxIn {
6486                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6487                 script_sig: Script::new(),
6488                 sequence: 0,
6489                 witness: Vec::new(),
6490         };
6491
6492         let outp = TxOut {
6493                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6494                 value: 10000,
6495         };
6496
6497         let dummy_tx = Transaction {
6498                 version: 2,
6499                 lock_time: 0,
6500                 input: vec![input],
6501                 output: vec![outp]
6502         };
6503
6504         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6505         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6506         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6507         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6508         // We broadcast a few more block to check everything is all right
6509         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
6510         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6511         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6512
6513         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6514         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6515 }
6516
6517 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6518         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6519         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6520         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6521         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6522         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6523         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6524
6525         let chanmon_cfgs = create_chanmon_cfgs(3);
6526         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6527         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6528         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6529         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6530
6531         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6532
6533         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6534         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6535
6536         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6537         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
6538
6539         // We revoked bs_commitment_tx
6540         if revoked {
6541                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6542                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6543         }
6544
6545         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6546         let mut timeout_tx = Vec::new();
6547         if local {
6548                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6549                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6550                 check_closed_broadcast!(nodes[0], false);
6551                 check_added_monitors!(nodes[0], 1);
6552                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6553                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6554                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6555                 let events = nodes[0].node.get_and_clear_pending_events();
6556                 assert_eq!(events.len(), 1);
6557                 match events[0] {
6558                         Event::PaymentFailed { payment_hash, .. } => {
6559                                 assert_eq!(payment_hash, dust_hash);
6560                         },
6561                         _ => panic!("Unexpected event"),
6562                 }
6563                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6564                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6565                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6566                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6567                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6568                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6569                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6570                 let events = nodes[0].node.get_and_clear_pending_events();
6571                 assert_eq!(events.len(), 1);
6572                 match events[0] {
6573                         Event::PaymentFailed { payment_hash, .. } => {
6574                                 assert_eq!(payment_hash, non_dust_hash);
6575                         },
6576                         _ => panic!("Unexpected event"),
6577                 }
6578         } else {
6579                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6580                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6581                 check_closed_broadcast!(nodes[0], false);
6582                 check_added_monitors!(nodes[0], 1);
6583                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6584                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6585                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6586                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6587                 if !revoked {
6588                         let events = nodes[0].node.get_and_clear_pending_events();
6589                         assert_eq!(events.len(), 1);
6590                         match events[0] {
6591                                 Event::PaymentFailed { payment_hash, .. } => {
6592                                         assert_eq!(payment_hash, dust_hash);
6593                                 },
6594                                 _ => panic!("Unexpected event"),
6595                         }
6596                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6597                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6598                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6599                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6600                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6601                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6602                         let events = nodes[0].node.get_and_clear_pending_events();
6603                         assert_eq!(events.len(), 1);
6604                         match events[0] {
6605                                 Event::PaymentFailed { payment_hash, .. } => {
6606                                         assert_eq!(payment_hash, non_dust_hash);
6607                                 },
6608                                 _ => panic!("Unexpected event"),
6609                         }
6610                 } else {
6611                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6612                         // commitment tx
6613                         let events = nodes[0].node.get_and_clear_pending_events();
6614                         assert_eq!(events.len(), 2);
6615                         let first;
6616                         match events[0] {
6617                                 Event::PaymentFailed { payment_hash, .. } => {
6618                                         if payment_hash == dust_hash { first = true; }
6619                                         else { first = false; }
6620                                 },
6621                                 _ => panic!("Unexpected event"),
6622                         }
6623                         match events[1] {
6624                                 Event::PaymentFailed { payment_hash, .. } => {
6625                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6626                                         else { assert_eq!(payment_hash, dust_hash); }
6627                                 },
6628                                 _ => panic!("Unexpected event"),
6629                         }
6630                 }
6631         }
6632 }
6633
6634 #[test]
6635 fn test_sweep_outbound_htlc_failure_update() {
6636         do_test_sweep_outbound_htlc_failure_update(false, true);
6637         do_test_sweep_outbound_htlc_failure_update(false, false);
6638         do_test_sweep_outbound_htlc_failure_update(true, false);
6639 }
6640
6641 #[test]
6642 fn test_upfront_shutdown_script() {
6643         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6644         // enforce it at shutdown message
6645
6646         let mut config = UserConfig::default();
6647         config.channel_options.announced_channel = true;
6648         config.peer_channel_config_limits.force_announced_channel_preference = false;
6649         config.channel_options.commit_upfront_shutdown_pubkey = false;
6650         let user_cfgs = [None, Some(config), None];
6651         let chanmon_cfgs = create_chanmon_cfgs(3);
6652         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6653         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6654         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6655
6656         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6657         let flags = InitFeatures::supported();
6658         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6659         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6660         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6661         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6662         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6663         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6664         assert_eq!(check_closed_broadcast!(nodes[2], true).unwrap().data, "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6665         check_added_monitors!(nodes[2], 1);
6666
6667         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6668         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6669         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6670         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6671         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6672         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6673         let events = nodes[2].node.get_and_clear_pending_msg_events();
6674         assert_eq!(events.len(), 1);
6675         match events[0] {
6676                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6677                 _ => panic!("Unexpected event"),
6678         }
6679
6680         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6681         let mut flags_no = InitFeatures::supported();
6682         flags_no.unset_upfront_shutdown_script();
6683         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6684         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6685         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6686         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6687         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6688         let events = nodes[1].node.get_and_clear_pending_msg_events();
6689         assert_eq!(events.len(), 1);
6690         match events[0] {
6691                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6692                 _ => panic!("Unexpected event"),
6693         }
6694
6695         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6696         // channel smoothly, opt-out is from channel initiator here
6697         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6698         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6699         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6700         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6701         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6702         let events = nodes[0].node.get_and_clear_pending_msg_events();
6703         assert_eq!(events.len(), 1);
6704         match events[0] {
6705                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6706                 _ => panic!("Unexpected event"),
6707         }
6708
6709         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6710         //// channel smoothly
6711         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6712         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6713         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6714         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6715         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6716         let events = nodes[0].node.get_and_clear_pending_msg_events();
6717         assert_eq!(events.len(), 2);
6718         match events[0] {
6719                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6720                 _ => panic!("Unexpected event"),
6721         }
6722         match events[1] {
6723                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6724                 _ => panic!("Unexpected event"),
6725         }
6726 }
6727
6728 #[test]
6729 fn test_user_configurable_csv_delay() {
6730         // We test our channel constructors yield errors when we pass them absurd csv delay
6731
6732         let mut low_our_to_self_config = UserConfig::default();
6733         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6734         let mut high_their_to_self_config = UserConfig::default();
6735         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6736         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6737         let chanmon_cfgs = create_chanmon_cfgs(2);
6738         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6739         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6740         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6741
6742         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6743         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())));
6744         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) {
6745                 match error {
6746                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6747                         _ => panic!("Unexpected event"),
6748                 }
6749         } else { assert!(false) }
6750
6751         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6752         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6753         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6754         open_channel.to_self_delay = 200;
6755         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) {
6756                 match error {
6757                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6758                         _ => panic!("Unexpected event"),
6759                 }
6760         } else { assert!(false); }
6761
6762         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6763         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6764         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()));
6765         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6766         accept_channel.to_self_delay = 200;
6767         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6768         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6769                 match action {
6770                         &ErrorAction::SendErrorMessage { ref msg } => {
6771                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6772                         },
6773                         _ => { assert!(false); }
6774                 }
6775         } else { assert!(false); }
6776
6777         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6778         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6779         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6780         open_channel.to_self_delay = 200;
6781         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &high_their_to_self_config) {
6782                 match error {
6783                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6784                         _ => panic!("Unexpected event"),
6785                 }
6786         } else { assert!(false); }
6787 }
6788
6789 #[test]
6790 fn test_data_loss_protect() {
6791         // We want to be sure that :
6792         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6793         // * we close channel in case of detecting other being fallen behind
6794         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6795         let keys_manager;
6796         let fee_estimator;
6797         let tx_broadcaster;
6798         let monitor;
6799         let node_state_0;
6800         let chanmon_cfgs = create_chanmon_cfgs(2);
6801         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6802         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6803         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6804
6805         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6806
6807         // Cache node A state before any channel update
6808         let previous_node_state = nodes[0].node.encode();
6809         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6810         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6811
6812         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6813         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6814
6815         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6816         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6817
6818         // Restore node A from previous state
6819         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6820         let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6821         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6822         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
6823         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
6824         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger));
6825         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &tx_broadcaster, logger.clone(), &fee_estimator);
6826         node_state_0 = {
6827                 let mut channel_monitors = HashMap::new();
6828                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6829                 <(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 {
6830                         keys_manager: &keys_manager,
6831                         fee_estimator: &fee_estimator,
6832                         monitor: &monitor,
6833                         logger: Arc::clone(&logger),
6834                         tx_broadcaster: &tx_broadcaster,
6835                         default_config: UserConfig::default(),
6836                         channel_monitors: &mut channel_monitors,
6837                 }).unwrap().1
6838         };
6839         nodes[0].node = &node_state_0;
6840         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
6841         nodes[0].chan_monitor = &monitor;
6842         nodes[0].chain_monitor = chain_monitor;
6843
6844         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6845         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6846         nodes[0].block_notifier.register_listener(nodes[0].node);
6847
6848         check_added_monitors!(nodes[0], 1);
6849
6850         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6851         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6852
6853         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6854
6855         // Check we update monitor following learning of per_commitment_point from B
6856         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6857         check_added_monitors!(nodes[0], 2);
6858
6859         {
6860                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6861                 assert_eq!(node_txn.len(), 0);
6862         }
6863
6864         let mut reestablish_1 = Vec::with_capacity(1);
6865         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6866                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6867                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6868                         reestablish_1.push(msg.clone());
6869                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6870                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6871                         match action {
6872                                 &ErrorAction::SendErrorMessage { ref msg } => {
6873                                         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");
6874                                 },
6875                                 _ => panic!("Unexpected event!"),
6876                         }
6877                 } else {
6878                         panic!("Unexpected event")
6879                 }
6880         }
6881
6882         // Check we close channel detecting A is fallen-behind
6883         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6884         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
6885         check_added_monitors!(nodes[1], 1);
6886
6887
6888         // Check A is able to claim to_remote output
6889         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6890         assert_eq!(node_txn.len(), 1);
6891         check_spends!(node_txn[0], chan.3);
6892         assert_eq!(node_txn[0].output.len(), 2);
6893         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6894         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
6895         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
6896         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6897         assert_eq!(spend_txn.len(), 1);
6898         check_spends!(spend_txn[0], node_txn[0]);
6899 }
6900
6901 #[test]
6902 fn test_check_htlc_underpaying() {
6903         // Send payment through A -> B but A is maliciously
6904         // sending a probe payment (i.e less than expected value0
6905         // to B, B should refuse payment.
6906
6907         let chanmon_cfgs = create_chanmon_cfgs(2);
6908         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6909         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6910         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6911
6912         // Create some initial channels
6913         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6914
6915         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6916
6917         // Node 3 is expecting payment of 100_000 but receive 10_000,
6918         // fail htlc like we didn't know the preimage.
6919         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
6920         nodes[1].node.process_pending_htlc_forwards();
6921
6922         let events = nodes[1].node.get_and_clear_pending_msg_events();
6923         assert_eq!(events.len(), 1);
6924         let (update_fail_htlc, commitment_signed) = match events[0] {
6925                 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 } } => {
6926                         assert!(update_add_htlcs.is_empty());
6927                         assert!(update_fulfill_htlcs.is_empty());
6928                         assert_eq!(update_fail_htlcs.len(), 1);
6929                         assert!(update_fail_malformed_htlcs.is_empty());
6930                         assert!(update_fee.is_none());
6931                         (update_fail_htlcs[0].clone(), commitment_signed)
6932                 },
6933                 _ => panic!("Unexpected event"),
6934         };
6935         check_added_monitors!(nodes[1], 1);
6936
6937         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6938         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6939
6940         let events = nodes[0].node.get_and_clear_pending_events();
6941         assert_eq!(events.len(), 1);
6942         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6943                 assert_eq!(*rejected_by_dest, true);
6944                 assert_eq!(error_code.unwrap(), 0x4000|15);
6945         } else {
6946                 panic!("Unexpected event");
6947         }
6948         nodes[1].node.get_and_clear_pending_events();
6949 }
6950
6951 #[test]
6952 fn test_announce_disable_channels() {
6953         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6954         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6955
6956         let chanmon_cfgs = create_chanmon_cfgs(2);
6957         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6958         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6959         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6960
6961         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6962         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6963         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6964
6965         // Disconnect peers
6966         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6967         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6968
6969         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6970         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6971         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6972         assert_eq!(msg_events.len(), 3);
6973         for e in msg_events {
6974                 match e {
6975                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6976                                 let short_id = msg.contents.short_channel_id;
6977                                 // Check generated channel_update match list in PendingChannelUpdate
6978                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6979                                         panic!("Generated ChannelUpdate for wrong chan!");
6980                                 }
6981                         },
6982                         _ => panic!("Unexpected event"),
6983                 }
6984         }
6985         // Reconnect peers
6986         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6987         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6988         assert_eq!(reestablish_1.len(), 3);
6989         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6990         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6991         assert_eq!(reestablish_2.len(), 3);
6992
6993         // Reestablish chan_1
6994         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6995         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6996         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6997         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6998         // Reestablish chan_2
6999         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7000         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7001         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7002         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7003         // Reestablish chan_3
7004         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7005         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7006         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7007         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7008
7009         nodes[0].node.timer_chan_freshness_every_min();
7010         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7011 }
7012
7013 #[test]
7014 fn test_bump_penalty_txn_on_revoked_commitment() {
7015         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7016         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7017
7018         let chanmon_cfgs = create_chanmon_cfgs(2);
7019         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7020         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7021         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7022
7023         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7024         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7025         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
7026         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7027
7028         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7029         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7030         assert_eq!(revoked_txn[0].output.len(), 4);
7031         assert_eq!(revoked_txn[0].input.len(), 1);
7032         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7033         let revoked_txid = revoked_txn[0].txid();
7034
7035         let mut penalty_sum = 0;
7036         for outp in revoked_txn[0].output.iter() {
7037                 if outp.script_pubkey.is_v0_p2wsh() {
7038                         penalty_sum += outp.value;
7039                 }
7040         }
7041
7042         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7043         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
7044
7045         // Actually revoke tx by claiming a HTLC
7046         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7047         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7048         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7049         check_added_monitors!(nodes[1], 1);
7050
7051         // One or more justice tx should have been broadcast, check it
7052         let penalty_1;
7053         let feerate_1;
7054         {
7055                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7056                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7057                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7058                 assert_eq!(node_txn[0].output.len(), 1);
7059                 check_spends!(node_txn[0], revoked_txn[0]);
7060                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7061                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7062                 penalty_1 = node_txn[0].txid();
7063                 node_txn.clear();
7064         };
7065
7066         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7067         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
7068         let mut penalty_2 = penalty_1;
7069         let mut feerate_2 = 0;
7070         {
7071                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7072                 assert_eq!(node_txn.len(), 1);
7073                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7074                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7075                         assert_eq!(node_txn[0].output.len(), 1);
7076                         check_spends!(node_txn[0], revoked_txn[0]);
7077                         penalty_2 = node_txn[0].txid();
7078                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7079                         assert_ne!(penalty_2, penalty_1);
7080                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7081                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7082                         // Verify 25% bump heuristic
7083                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7084                         node_txn.clear();
7085                 }
7086         }
7087         assert_ne!(feerate_2, 0);
7088
7089         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7090         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
7091         let penalty_3;
7092         let mut feerate_3 = 0;
7093         {
7094                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7095                 assert_eq!(node_txn.len(), 1);
7096                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7097                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7098                         assert_eq!(node_txn[0].output.len(), 1);
7099                         check_spends!(node_txn[0], revoked_txn[0]);
7100                         penalty_3 = node_txn[0].txid();
7101                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7102                         assert_ne!(penalty_3, penalty_2);
7103                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7104                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7105                         // Verify 25% bump heuristic
7106                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7107                         node_txn.clear();
7108                 }
7109         }
7110         assert_ne!(feerate_3, 0);
7111
7112         nodes[1].node.get_and_clear_pending_events();
7113         nodes[1].node.get_and_clear_pending_msg_events();
7114 }
7115
7116 #[test]
7117 fn test_bump_penalty_txn_on_revoked_htlcs() {
7118         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7119         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7120
7121         let chanmon_cfgs = create_chanmon_cfgs(2);
7122         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7123         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7124         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7125
7126         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7127         // Lock HTLC in both directions
7128         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7129         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7130
7131         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7132         assert_eq!(revoked_local_txn[0].input.len(), 1);
7133         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7134
7135         // Revoke local commitment tx
7136         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7137
7138         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7139         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7140         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7141         check_closed_broadcast!(nodes[1], false);
7142         check_added_monitors!(nodes[1], 1);
7143
7144         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7145         assert_eq!(revoked_htlc_txn.len(), 6);
7146         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7147                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7148                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7149                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7150                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7151                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7152         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7153                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7154                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7155                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7156                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7157                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7158         }
7159
7160         // Broadcast set of revoked txn on A
7161         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
7162         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7163         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);
7164         let first;
7165         let feerate_1;
7166         let penalty_txn;
7167         {
7168                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7169                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7170                 // Verify claim tx are spending revoked HTLC txn
7171                 assert_eq!(node_txn[4].input.len(), 2);
7172                 assert_eq!(node_txn[4].output.len(), 1);
7173                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7174                 first = node_txn[4].txid();
7175                 // Store both feerates for later comparison
7176                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7177                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7178                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7179                 node_txn.clear();
7180         }
7181
7182         // Connect three more block to see if bumped penalty are issued for HTLC txn
7183         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7184         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7185         {
7186                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7187                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7188
7189                 check_spends!(node_txn[0], revoked_local_txn[0]);
7190                 check_spends!(node_txn[1], revoked_local_txn[0]);
7191
7192                 node_txn.clear();
7193         };
7194
7195         // Few more blocks to confirm penalty txn
7196         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
7197         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7198         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
7199         let node_txn = {
7200                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7201                 assert_eq!(node_txn.len(), 1);
7202
7203                 assert_eq!(node_txn[0].input.len(), 2);
7204                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7205                 // Verify bumped tx is different and 25% bump heuristic
7206                 assert_ne!(first, node_txn[0].txid());
7207                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7208                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7209                 assert!(feerate_2 * 100 > feerate_1 * 125);
7210                 let txn = vec![node_txn[0].clone()];
7211                 node_txn.clear();
7212                 txn
7213         };
7214         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7215         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7216         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
7217         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
7218         {
7219                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7220                 // We verify than no new transaction has been broadcast because previously
7221                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7222                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7223                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7224                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7225                 // up bumped justice generation.
7226                 assert_eq!(node_txn.len(), 0);
7227                 node_txn.clear();
7228         }
7229         check_closed_broadcast!(nodes[0], false);
7230         check_added_monitors!(nodes[0], 1);
7231 }
7232
7233 #[test]
7234 fn test_bump_penalty_txn_on_remote_commitment() {
7235         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7236         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7237
7238         // Create 2 HTLCs
7239         // Provide preimage for one
7240         // Check aggregation
7241
7242         let chanmon_cfgs = create_chanmon_cfgs(2);
7243         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7244         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7245         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7246
7247         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7248         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7249         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7250
7251         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7252         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7253         assert_eq!(remote_txn[0].output.len(), 4);
7254         assert_eq!(remote_txn[0].input.len(), 1);
7255         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7256
7257         // Claim a HTLC without revocation (provide B monitor with preimage)
7258         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7259         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7260         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7261         check_added_monitors!(nodes[1], 2);
7262
7263         // One or more claim tx should have been broadcast, check it
7264         let timeout;
7265         let preimage;
7266         let feerate_timeout;
7267         let feerate_preimage;
7268         {
7269                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7270                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7271                 assert_eq!(node_txn[0].input.len(), 1);
7272                 assert_eq!(node_txn[1].input.len(), 1);
7273                 check_spends!(node_txn[0], remote_txn[0]);
7274                 check_spends!(node_txn[1], remote_txn[0]);
7275                 check_spends!(node_txn[2], chan.3);
7276                 check_spends!(node_txn[3], node_txn[2]);
7277                 check_spends!(node_txn[4], node_txn[2]);
7278                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7279                         timeout = node_txn[0].txid();
7280                         let index = node_txn[0].input[0].previous_output.vout;
7281                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7282                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7283
7284                         preimage = node_txn[1].txid();
7285                         let index = node_txn[1].input[0].previous_output.vout;
7286                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7287                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7288                 } else {
7289                         timeout = node_txn[1].txid();
7290                         let index = node_txn[1].input[0].previous_output.vout;
7291                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7292                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7293
7294                         preimage = node_txn[0].txid();
7295                         let index = node_txn[0].input[0].previous_output.vout;
7296                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7297                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7298                 }
7299                 node_txn.clear();
7300         };
7301         assert_ne!(feerate_timeout, 0);
7302         assert_ne!(feerate_preimage, 0);
7303
7304         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7305         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
7306         {
7307                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7308                 assert_eq!(node_txn.len(), 2);
7309                 assert_eq!(node_txn[0].input.len(), 1);
7310                 assert_eq!(node_txn[1].input.len(), 1);
7311                 check_spends!(node_txn[0], remote_txn[0]);
7312                 check_spends!(node_txn[1], remote_txn[0]);
7313                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7314                         let index = node_txn[0].input[0].previous_output.vout;
7315                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7316                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7317                         assert!(new_feerate * 100 > feerate_timeout * 125);
7318                         assert_ne!(timeout, node_txn[0].txid());
7319
7320                         let index = node_txn[1].input[0].previous_output.vout;
7321                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7322                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7323                         assert!(new_feerate * 100 > feerate_preimage * 125);
7324                         assert_ne!(preimage, node_txn[1].txid());
7325                 } else {
7326                         let index = node_txn[1].input[0].previous_output.vout;
7327                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7328                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7329                         assert!(new_feerate * 100 > feerate_timeout * 125);
7330                         assert_ne!(timeout, node_txn[1].txid());
7331
7332                         let index = node_txn[0].input[0].previous_output.vout;
7333                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7334                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7335                         assert!(new_feerate * 100 > feerate_preimage * 125);
7336                         assert_ne!(preimage, node_txn[0].txid());
7337                 }
7338                 node_txn.clear();
7339         }
7340
7341         nodes[1].node.get_and_clear_pending_events();
7342         nodes[1].node.get_and_clear_pending_msg_events();
7343 }
7344
7345 #[test]
7346 fn test_set_outpoints_partial_claiming() {
7347         // - remote party claim tx, new bump tx
7348         // - disconnect remote claiming tx, new bump
7349         // - disconnect tx, see no tx anymore
7350         let chanmon_cfgs = create_chanmon_cfgs(2);
7351         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7352         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7353         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7354
7355         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7356         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7357         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7358
7359         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7360         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
7361         assert_eq!(remote_txn.len(), 3);
7362         assert_eq!(remote_txn[0].output.len(), 4);
7363         assert_eq!(remote_txn[0].input.len(), 1);
7364         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7365         check_spends!(remote_txn[1], remote_txn[0]);
7366         check_spends!(remote_txn[2], remote_txn[0]);
7367
7368         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7369         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7370         // Provide node A with both preimage
7371         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
7372         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
7373         check_added_monitors!(nodes[0], 2);
7374         nodes[0].node.get_and_clear_pending_events();
7375         nodes[0].node.get_and_clear_pending_msg_events();
7376
7377         // Connect blocks on node A commitment transaction
7378         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7379         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7380         check_closed_broadcast!(nodes[0], false);
7381         check_added_monitors!(nodes[0], 1);
7382         // Verify node A broadcast tx claiming both HTLCs
7383         {
7384                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7385                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7386                 assert_eq!(node_txn.len(), 4);
7387                 check_spends!(node_txn[0], remote_txn[0]);
7388                 check_spends!(node_txn[1], chan.3);
7389                 check_spends!(node_txn[2], node_txn[1]);
7390                 check_spends!(node_txn[3], node_txn[1]);
7391                 assert_eq!(node_txn[0].input.len(), 2);
7392                 node_txn.clear();
7393         }
7394
7395         // Connect blocks on node B
7396         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7397         check_closed_broadcast!(nodes[1], false);
7398         check_added_monitors!(nodes[1], 1);
7399         // Verify node B broadcast 2 HTLC-timeout txn
7400         let partial_claim_tx = {
7401                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7402                 assert_eq!(node_txn.len(), 3);
7403                 check_spends!(node_txn[1], node_txn[0]);
7404                 check_spends!(node_txn[2], node_txn[0]);
7405                 assert_eq!(node_txn[1].input.len(), 1);
7406                 assert_eq!(node_txn[2].input.len(), 1);
7407                 node_txn[1].clone()
7408         };
7409
7410         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7411         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7412         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7413         {
7414                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7415                 assert_eq!(node_txn.len(), 1);
7416                 check_spends!(node_txn[0], remote_txn[0]);
7417                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7418                 node_txn.clear();
7419         }
7420         nodes[0].node.get_and_clear_pending_msg_events();
7421
7422         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7423         nodes[0].block_notifier.block_disconnected(&header, 102);
7424         {
7425                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7426                 assert_eq!(node_txn.len(), 1);
7427                 check_spends!(node_txn[0], remote_txn[0]);
7428                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7429                 node_txn.clear();
7430         }
7431
7432         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7433         nodes[0].block_notifier.block_disconnected(&header, 101);
7434         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7435         {
7436                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7437                 assert_eq!(node_txn.len(), 0);
7438                 node_txn.clear();
7439         }
7440 }
7441
7442 #[test]
7443 fn test_counterparty_raa_skip_no_crash() {
7444         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7445         // commitment transaction, we would have happily carried on and provided them the next
7446         // commitment transaction based on one RAA forward. This would probably eventually have led to
7447         // channel closure, but it would not have resulted in funds loss. Still, our
7448         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7449         // check simply that the channel is closed in response to such an RAA, but don't check whether
7450         // we decide to punish our counterparty for revoking their funds (as we don't currently
7451         // implement that).
7452         let chanmon_cfgs = create_chanmon_cfgs(2);
7453         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7454         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7455         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7456         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7457
7458         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7459         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7460         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7461                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7462         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7463
7464         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7465                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7466         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7467         check_added_monitors!(nodes[1], 1);
7468 }
7469
7470 #[test]
7471 fn test_bump_txn_sanitize_tracking_maps() {
7472         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7473         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7474
7475         let chanmon_cfgs = create_chanmon_cfgs(2);
7476         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7477         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7478         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7479
7480         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7481         // Lock HTLC in both directions
7482         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7483         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7484
7485         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7486         assert_eq!(revoked_local_txn[0].input.len(), 1);
7487         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7488
7489         // Revoke local commitment tx
7490         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7491
7492         // Broadcast set of revoked txn on A
7493         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7494         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7495         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7496         check_closed_broadcast!(nodes[0], false);
7497         check_added_monitors!(nodes[0], 1);
7498         let penalty_txn = {
7499                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7500                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7501                 check_spends!(node_txn[0], revoked_local_txn[0]);
7502                 check_spends!(node_txn[1], revoked_local_txn[0]);
7503                 check_spends!(node_txn[2], revoked_local_txn[0]);
7504                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7505                 node_txn.clear();
7506                 penalty_txn
7507         };
7508         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7509         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7510         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7511         {
7512                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7513                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7514                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
7515                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
7516                 }
7517         }
7518 }
7519
7520 #[test]
7521 fn test_override_channel_config() {
7522         let chanmon_cfgs = create_chanmon_cfgs(2);
7523         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7524         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7525         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7526
7527         // Node0 initiates a channel to node1 using the override config.
7528         let mut override_config = UserConfig::default();
7529         override_config.own_channel_config.our_to_self_delay = 200;
7530
7531         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7532
7533         // Assert the channel created by node0 is using the override config.
7534         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7535         assert_eq!(res.channel_flags, 0);
7536         assert_eq!(res.to_self_delay, 200);
7537 }
7538
7539 #[test]
7540 fn test_override_0msat_htlc_minimum() {
7541         let mut zero_config = UserConfig::default();
7542         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
7543         let chanmon_cfgs = create_chanmon_cfgs(2);
7544         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7545         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7546         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7547
7548         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7549         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7550         assert_eq!(res.htlc_minimum_msat, 1);
7551
7552         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &res);
7553         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7554         assert_eq!(res.htlc_minimum_msat, 1);
7555 }
7556
7557 #[test]
7558 fn test_simple_payment_secret() {
7559         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
7560         // features, however.
7561         let chanmon_cfgs = create_chanmon_cfgs(3);
7562         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7563         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7564         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7565
7566         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
7567         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
7568
7569         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7570         let payment_secret = PaymentSecret([0xdb; 32]);
7571         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7572         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
7573         // Claiming with all the correct values but the wrong secret should result in nothing...
7574         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
7575         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
7576         // ...but with the right secret we should be able to claim all the way back
7577         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
7578 }
7579
7580 #[test]
7581 fn test_simple_mpp() {
7582         // Simple test of sending a multi-path payment.
7583         let chanmon_cfgs = create_chanmon_cfgs(4);
7584         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7585         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7586         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7587
7588         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7589         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7590         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7591         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7592
7593         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7594         let payment_secret = PaymentSecret([0xdb; 32]);
7595         let mut route = nodes[0].router.get_route(&nodes[3].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7596         let path = route.paths[0].clone();
7597         route.paths.push(path);
7598         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7599         route.paths[0][0].short_channel_id = chan_1_id;
7600         route.paths[0][1].short_channel_id = chan_3_id;
7601         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7602         route.paths[1][0].short_channel_id = chan_2_id;
7603         route.paths[1][1].short_channel_id = chan_4_id;
7604         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
7605         // Claiming with all the correct values but the wrong secret should result in nothing...
7606         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
7607         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
7608         // ...but with the right secret we should be able to claim all the way back
7609         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
7610 }