_ 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(), 9);
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, after one increase, bumps on HTLC aren't generated not being substantial anymore, bump on revoked to_local isn't generated due to more room for expiration (2)
2342                 // ChannelMonitor: local commitment + local HTLC-timeout (2)
2343
2344                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration
2345                 assert_eq!(node_txn[3].input.len(), 1);
2346                 check_spends!(node_txn[3], chan_1.3);
2347                 assert_eq!(node_txn[0].input.len(), 1);
2348                 let witness_script = node_txn[0].input[0].witness.last().unwrap();
2349                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2350                 check_spends!(node_txn[0], node_txn[3]);
2351
2352                 // Justice transactions are indices 1-2-4
2353                 assert_eq!(node_txn[1].input.len(), 1);
2354                 assert_eq!(node_txn[2].input.len(), 1);
2355                 assert_eq!(node_txn[4].input.len(), 1);
2356
2357                 check_spends!(node_txn[1], revoked_local_txn[0]);
2358                 check_spends!(node_txn[2], revoked_local_txn[0]);
2359                 check_spends!(node_txn[4], revoked_local_txn[0]);
2360
2361                 let mut witness_lens = BTreeSet::new();
2362                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2363                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2364                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2365                 assert_eq!(witness_lens.len(), 3);
2366                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2367                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2368                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2369         }
2370         get_announce_close_broadcast_events(&nodes, 0, 1);
2371         assert_eq!(nodes[0].node.list_channels().len(), 0);
2372         assert_eq!(nodes[1].node.list_channels().len(), 0);
2373 }
2374
2375 #[test]
2376 fn test_htlc_on_chain_success() {
2377         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2378         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2379         // broadcasting the right event to other nodes in payment path.
2380         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2381         // A --------------------> B ----------------------> C (preimage)
2382         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2383         // commitment transaction was broadcast.
2384         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2385         // towards B.
2386         // B should be able to claim via preimage if A then broadcasts its local tx.
2387         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2388         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2389         // PaymentSent event).
2390
2391         let chanmon_cfgs = create_chanmon_cfgs(3);
2392         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2393         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2394         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2395
2396         // Create some initial channels
2397         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2398         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2399
2400         // Rebalance the network a bit by relaying one payment through all the channels...
2401         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2402         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2403
2404         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2405         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2406         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2407
2408         // Broadcast legit commitment tx from C on B's chain
2409         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2410         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2411         assert_eq!(commitment_tx.len(), 1);
2412         check_spends!(commitment_tx[0], chan_2.3);
2413         nodes[2].node.claim_funds(our_payment_preimage, &None, 3_000_000);
2414         nodes[2].node.claim_funds(our_payment_preimage_2, &None, 3_000_000);
2415         check_added_monitors!(nodes[2], 2);
2416         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2417         assert!(updates.update_add_htlcs.is_empty());
2418         assert!(updates.update_fail_htlcs.is_empty());
2419         assert!(updates.update_fail_malformed_htlcs.is_empty());
2420         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2421
2422         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2423         check_closed_broadcast!(nodes[2], false);
2424         check_added_monitors!(nodes[2], 1);
2425         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 2 (2 * HTLC-Success tx)
2426         assert_eq!(node_txn.len(), 5);
2427         assert_eq!(node_txn[0], node_txn[3]);
2428         assert_eq!(node_txn[1], node_txn[4]);
2429         assert_eq!(node_txn[2], commitment_tx[0]);
2430         check_spends!(node_txn[0], commitment_tx[0]);
2431         check_spends!(node_txn[1], commitment_tx[0]);
2432         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2433         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2434         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2435         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2436         assert_eq!(node_txn[0].lock_time, 0);
2437         assert_eq!(node_txn[1].lock_time, 0);
2438
2439         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2440         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2441         {
2442                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2443                 assert_eq!(added_monitors.len(), 1);
2444                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2445                 added_monitors.clear();
2446         }
2447         let events = nodes[1].node.get_and_clear_pending_msg_events();
2448         {
2449                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2450                 assert_eq!(added_monitors.len(), 2);
2451                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2452                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2453                 added_monitors.clear();
2454         }
2455         assert_eq!(events.len(), 2);
2456         match events[0] {
2457                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2458                 _ => panic!("Unexpected event"),
2459         }
2460         match events[1] {
2461                 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, .. } } => {
2462                         assert!(update_add_htlcs.is_empty());
2463                         assert!(update_fail_htlcs.is_empty());
2464                         assert_eq!(update_fulfill_htlcs.len(), 1);
2465                         assert!(update_fail_malformed_htlcs.is_empty());
2466                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2467                 },
2468                 _ => panic!("Unexpected event"),
2469         };
2470         macro_rules! check_tx_local_broadcast {
2471                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2472                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2473                         assert_eq!(node_txn.len(), 5);
2474                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2475                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout
2476                         check_spends!(node_txn[0], $commitment_tx);
2477                         check_spends!(node_txn[1], $commitment_tx);
2478                         assert_ne!(node_txn[0].lock_time, 0);
2479                         assert_ne!(node_txn[1].lock_time, 0);
2480                         if $htlc_offered {
2481                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2482                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2483                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2484                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2485                         } else {
2486                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2487                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2488                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2489                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2490                         }
2491                         check_spends!(node_txn[2], $chan_tx);
2492                         check_spends!(node_txn[3], node_txn[2]);
2493                         check_spends!(node_txn[4], node_txn[2]);
2494                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2495                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2496                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2497                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2498                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2499                         assert_ne!(node_txn[3].lock_time, 0);
2500                         assert_ne!(node_txn[4].lock_time, 0);
2501                         node_txn.clear();
2502                 } }
2503         }
2504         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2505         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2506         // timeout-claim of the output that nodes[2] just claimed via success.
2507         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2508
2509         // Broadcast legit commitment tx from A on B's chain
2510         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2511         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2512         check_spends!(commitment_tx[0], chan_1.3);
2513         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2514         check_closed_broadcast!(nodes[1], false);
2515         check_added_monitors!(nodes[1], 1);
2516         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2517         assert_eq!(node_txn.len(), 4);
2518         check_spends!(node_txn[0], commitment_tx[0]);
2519         assert_eq!(node_txn[0].input.len(), 2);
2520         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2521         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2522         assert_eq!(node_txn[0].lock_time, 0);
2523         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2524         check_spends!(node_txn[1], chan_1.3);
2525         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2526         check_spends!(node_txn[2], node_txn[1]);
2527         check_spends!(node_txn[3], node_txn[1]);
2528         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2529         // we already checked the same situation with A.
2530
2531         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2532         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2533         check_closed_broadcast!(nodes[0], false);
2534         check_added_monitors!(nodes[0], 1);
2535         let events = nodes[0].node.get_and_clear_pending_events();
2536         assert_eq!(events.len(), 2);
2537         let mut first_claimed = false;
2538         for event in events {
2539                 match event {
2540                         Event::PaymentSent { payment_preimage } => {
2541                                 if payment_preimage == our_payment_preimage {
2542                                         assert!(!first_claimed);
2543                                         first_claimed = true;
2544                                 } else {
2545                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2546                                 }
2547                         },
2548                         _ => panic!("Unexpected event"),
2549                 }
2550         }
2551         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2552 }
2553
2554 #[test]
2555 fn test_htlc_on_chain_timeout() {
2556         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2557         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2558         // broadcasting the right event to other nodes in payment path.
2559         // A ------------------> B ----------------------> C (timeout)
2560         //    B's commitment tx                 C's commitment tx
2561         //            \                                  \
2562         //         B's HTLC timeout tx               B's timeout tx
2563
2564         let chanmon_cfgs = create_chanmon_cfgs(3);
2565         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2566         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2567         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2568
2569         // Create some intial channels
2570         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2571         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2572
2573         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2574         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2575         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2576
2577         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2578         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2579
2580         // Broadcast legit commitment tx from C on B's chain
2581         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2582         check_spends!(commitment_tx[0], chan_2.3);
2583         nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
2584         check_added_monitors!(nodes[2], 0);
2585         expect_pending_htlcs_forwardable!(nodes[2]);
2586         check_added_monitors!(nodes[2], 1);
2587
2588         let events = nodes[2].node.get_and_clear_pending_msg_events();
2589         assert_eq!(events.len(), 1);
2590         match events[0] {
2591                 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, .. } } => {
2592                         assert!(update_add_htlcs.is_empty());
2593                         assert!(!update_fail_htlcs.is_empty());
2594                         assert!(update_fulfill_htlcs.is_empty());
2595                         assert!(update_fail_malformed_htlcs.is_empty());
2596                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2597                 },
2598                 _ => panic!("Unexpected event"),
2599         };
2600         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2601         check_closed_broadcast!(nodes[2], false);
2602         check_added_monitors!(nodes[2], 1);
2603         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2604         assert_eq!(node_txn.len(), 1);
2605         check_spends!(node_txn[0], chan_2.3);
2606         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2607
2608         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2609         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2610         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2611         let timeout_tx;
2612         {
2613                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2614                 assert_eq!(node_txn.len(), 5); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (local commitment tx + HTLC-timeout), 1 timeout tx
2615
2616                 assert_eq!(node_txn[2], node_txn[3]);
2617                 assert_eq!(node_txn[0], node_txn[4]);
2618
2619                 check_spends!(node_txn[1], commitment_tx[0]);
2620                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2621
2622                 check_spends!(node_txn[2], chan_2.3);
2623                 check_spends!(node_txn[0], node_txn[2]);
2624                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), 71);
2625                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2626
2627                 timeout_tx = node_txn[1].clone();
2628                 node_txn.clear();
2629         }
2630
2631         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2632         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2633         check_added_monitors!(nodes[1], 1);
2634         check_closed_broadcast!(nodes[1], false);
2635
2636         expect_pending_htlcs_forwardable!(nodes[1]);
2637         check_added_monitors!(nodes[1], 1);
2638         let events = nodes[1].node.get_and_clear_pending_msg_events();
2639         assert_eq!(events.len(), 1);
2640         match events[0] {
2641                 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, .. } } => {
2642                         assert!(update_add_htlcs.is_empty());
2643                         assert!(!update_fail_htlcs.is_empty());
2644                         assert!(update_fulfill_htlcs.is_empty());
2645                         assert!(update_fail_malformed_htlcs.is_empty());
2646                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2647                 },
2648                 _ => panic!("Unexpected event"),
2649         };
2650         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
2651         assert_eq!(node_txn.len(), 0);
2652
2653         // Broadcast legit commitment tx from B on A's chain
2654         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2655         check_spends!(commitment_tx[0], chan_1.3);
2656
2657         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2658         check_closed_broadcast!(nodes[0], false);
2659         check_added_monitors!(nodes[0], 1);
2660         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2661         assert_eq!(node_txn.len(), 3);
2662         check_spends!(node_txn[0], commitment_tx[0]);
2663         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2664         check_spends!(node_txn[1], chan_1.3);
2665         check_spends!(node_txn[2], node_txn[1]);
2666         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2667         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2668 }
2669
2670 #[test]
2671 fn test_simple_commitment_revoked_fail_backward() {
2672         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2673         // and fail backward accordingly.
2674
2675         let chanmon_cfgs = create_chanmon_cfgs(3);
2676         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2677         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2678         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2679
2680         // Create some initial channels
2681         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2682         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2683
2684         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2685         // Get the will-be-revoked local txn from nodes[2]
2686         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2687         // Revoke the old state
2688         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2689
2690         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2691
2692         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2693         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2694         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2695         check_added_monitors!(nodes[1], 1);
2696         check_closed_broadcast!(nodes[1], false);
2697
2698         expect_pending_htlcs_forwardable!(nodes[1]);
2699         check_added_monitors!(nodes[1], 1);
2700         let events = nodes[1].node.get_and_clear_pending_msg_events();
2701         assert_eq!(events.len(), 1);
2702         match events[0] {
2703                 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, .. } } => {
2704                         assert!(update_add_htlcs.is_empty());
2705                         assert_eq!(update_fail_htlcs.len(), 1);
2706                         assert!(update_fulfill_htlcs.is_empty());
2707                         assert!(update_fail_malformed_htlcs.is_empty());
2708                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2709
2710                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2711                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2712
2713                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2714                         assert_eq!(events.len(), 1);
2715                         match events[0] {
2716                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2717                                 _ => panic!("Unexpected event"),
2718                         }
2719                         let events = nodes[0].node.get_and_clear_pending_events();
2720                         assert_eq!(events.len(), 1);
2721                         match events[0] {
2722                                 Event::PaymentFailed { .. } => {},
2723                                 _ => panic!("Unexpected event"),
2724                         }
2725                 },
2726                 _ => panic!("Unexpected event"),
2727         }
2728 }
2729
2730 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2731         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2732         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2733         // commitment transaction anymore.
2734         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2735         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2736         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2737         // technically disallowed and we should probably handle it reasonably.
2738         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2739         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2740         // transactions:
2741         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2742         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2743         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2744         //   and once they revoke the previous commitment transaction (allowing us to send a new
2745         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2746         let chanmon_cfgs = create_chanmon_cfgs(3);
2747         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2748         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2749         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2750
2751         // Create some initial channels
2752         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2753         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2754
2755         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2756         // Get the will-be-revoked local txn from nodes[2]
2757         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2758         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2759         // Revoke the old state
2760         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2761
2762         let value = if use_dust {
2763                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2764                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2765                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2766         } else { 3000000 };
2767
2768         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2769         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2770         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2771
2772         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash, &None));
2773         expect_pending_htlcs_forwardable!(nodes[2]);
2774         check_added_monitors!(nodes[2], 1);
2775         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2776         assert!(updates.update_add_htlcs.is_empty());
2777         assert!(updates.update_fulfill_htlcs.is_empty());
2778         assert!(updates.update_fail_malformed_htlcs.is_empty());
2779         assert_eq!(updates.update_fail_htlcs.len(), 1);
2780         assert!(updates.update_fee.is_none());
2781         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2782         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2783         // Drop the last RAA from 3 -> 2
2784
2785         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash, &None));
2786         expect_pending_htlcs_forwardable!(nodes[2]);
2787         check_added_monitors!(nodes[2], 1);
2788         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2789         assert!(updates.update_add_htlcs.is_empty());
2790         assert!(updates.update_fulfill_htlcs.is_empty());
2791         assert!(updates.update_fail_malformed_htlcs.is_empty());
2792         assert_eq!(updates.update_fail_htlcs.len(), 1);
2793         assert!(updates.update_fee.is_none());
2794         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2795         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2796         check_added_monitors!(nodes[1], 1);
2797         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2798         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2799         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2800         check_added_monitors!(nodes[2], 1);
2801
2802         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash, &None));
2803         expect_pending_htlcs_forwardable!(nodes[2]);
2804         check_added_monitors!(nodes[2], 1);
2805         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2806         assert!(updates.update_add_htlcs.is_empty());
2807         assert!(updates.update_fulfill_htlcs.is_empty());
2808         assert!(updates.update_fail_malformed_htlcs.is_empty());
2809         assert_eq!(updates.update_fail_htlcs.len(), 1);
2810         assert!(updates.update_fee.is_none());
2811         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2812         // At this point first_payment_hash has dropped out of the latest two commitment
2813         // transactions that nodes[1] is tracking...
2814         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2815         check_added_monitors!(nodes[1], 1);
2816         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2817         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2818         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2819         check_added_monitors!(nodes[2], 1);
2820
2821         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2822         // on nodes[2]'s RAA.
2823         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2824         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2825         nodes[1].node.send_payment(&route, fourth_payment_hash, &None).unwrap();
2826         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2827         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2828         check_added_monitors!(nodes[1], 0);
2829
2830         if deliver_bs_raa {
2831                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2832                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2833                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2834                 check_added_monitors!(nodes[1], 1);
2835                 let events = nodes[1].node.get_and_clear_pending_events();
2836                 assert_eq!(events.len(), 1);
2837                 match events[0] {
2838                         Event::PendingHTLCsForwardable { .. } => { },
2839                         _ => panic!("Unexpected event"),
2840                 };
2841                 // Deliberately don't process the pending fail-back so they all fail back at once after
2842                 // block connection just like the !deliver_bs_raa case
2843         }
2844
2845         let mut failed_htlcs = HashSet::new();
2846         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2847
2848         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2849         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2850         check_added_monitors!(nodes[1], 1);
2851         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2852
2853         let events = nodes[1].node.get_and_clear_pending_events();
2854         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2855         match events[0] {
2856                 Event::PaymentFailed { ref payment_hash, .. } => {
2857                         assert_eq!(*payment_hash, fourth_payment_hash);
2858                 },
2859                 _ => panic!("Unexpected event"),
2860         }
2861         if !deliver_bs_raa {
2862                 match events[1] {
2863                         Event::PendingHTLCsForwardable { .. } => { },
2864                         _ => panic!("Unexpected event"),
2865                 };
2866         }
2867         nodes[1].node.process_pending_htlc_forwards();
2868         check_added_monitors!(nodes[1], 1);
2869
2870         let events = nodes[1].node.get_and_clear_pending_msg_events();
2871         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2872         match events[if deliver_bs_raa { 1 } else { 0 }] {
2873                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2874                 _ => panic!("Unexpected event"),
2875         }
2876         if deliver_bs_raa {
2877                 match events[0] {
2878                         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, .. } } => {
2879                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2880                                 assert_eq!(update_add_htlcs.len(), 1);
2881                                 assert!(update_fulfill_htlcs.is_empty());
2882                                 assert!(update_fail_htlcs.is_empty());
2883                                 assert!(update_fail_malformed_htlcs.is_empty());
2884                         },
2885                         _ => panic!("Unexpected event"),
2886                 }
2887         }
2888         match events[if deliver_bs_raa { 2 } else { 1 }] {
2889                 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, .. } } => {
2890                         assert!(update_add_htlcs.is_empty());
2891                         assert_eq!(update_fail_htlcs.len(), 3);
2892                         assert!(update_fulfill_htlcs.is_empty());
2893                         assert!(update_fail_malformed_htlcs.is_empty());
2894                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2895
2896                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2897                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2898                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2899
2900                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2901
2902                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2903                         // If we delivered B's RAA we got an unknown preimage error, not something
2904                         // that we should update our routing table for.
2905                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2906                         for event in events {
2907                                 match event {
2908                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2909                                         _ => panic!("Unexpected event"),
2910                                 }
2911                         }
2912                         let events = nodes[0].node.get_and_clear_pending_events();
2913                         assert_eq!(events.len(), 3);
2914                         match events[0] {
2915                                 Event::PaymentFailed { ref payment_hash, .. } => {
2916                                         assert!(failed_htlcs.insert(payment_hash.0));
2917                                 },
2918                                 _ => panic!("Unexpected event"),
2919                         }
2920                         match events[1] {
2921                                 Event::PaymentFailed { ref payment_hash, .. } => {
2922                                         assert!(failed_htlcs.insert(payment_hash.0));
2923                                 },
2924                                 _ => panic!("Unexpected event"),
2925                         }
2926                         match events[2] {
2927                                 Event::PaymentFailed { ref payment_hash, .. } => {
2928                                         assert!(failed_htlcs.insert(payment_hash.0));
2929                                 },
2930                                 _ => panic!("Unexpected event"),
2931                         }
2932                 },
2933                 _ => panic!("Unexpected event"),
2934         }
2935
2936         assert!(failed_htlcs.contains(&first_payment_hash.0));
2937         assert!(failed_htlcs.contains(&second_payment_hash.0));
2938         assert!(failed_htlcs.contains(&third_payment_hash.0));
2939 }
2940
2941 #[test]
2942 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2943         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2944         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2945         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2946         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2947 }
2948
2949 #[test]
2950 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2951         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2952         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2953         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2954         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2955 }
2956
2957 #[test]
2958 fn fail_backward_pending_htlc_upon_channel_failure() {
2959         let chanmon_cfgs = create_chanmon_cfgs(2);
2960         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2961         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2962         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2963         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::supported(), InitFeatures::supported());
2964
2965         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
2966         {
2967                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
2968                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2969                 nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
2970                 check_added_monitors!(nodes[0], 1);
2971
2972                 let payment_event = {
2973                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2974                         assert_eq!(events.len(), 1);
2975                         SendEvent::from_event(events.remove(0))
2976                 };
2977                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
2978                 assert_eq!(payment_event.msgs.len(), 1);
2979         }
2980
2981         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
2982         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2983         {
2984                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2985                 nodes[0].node.send_payment(&route, failed_payment_hash, &None).unwrap();
2986                 check_added_monitors!(nodes[0], 0);
2987
2988                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2989         }
2990
2991         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
2992         {
2993                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
2994                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
2995
2996                 let secp_ctx = Secp256k1::new();
2997                 let session_priv = {
2998                         let mut session_key = [0; 32];
2999                         let mut rng = thread_rng();
3000                         rng.fill_bytes(&mut session_key);
3001                         SecretKey::from_slice(&session_key).expect("RNG is bad!")
3002                 };
3003
3004                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3005                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route.paths[0], 50_000, &None, current_height).unwrap();
3006                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route.paths[0], &session_priv).unwrap();
3007                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3008
3009                 // Send a 0-msat update_add_htlc to fail the channel.
3010                 let update_add_htlc = msgs::UpdateAddHTLC {
3011                         channel_id: chan.2,
3012                         htlc_id: 0,
3013                         amount_msat: 0,
3014                         payment_hash,
3015                         cltv_expiry,
3016                         onion_routing_packet,
3017                 };
3018                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3019         }
3020
3021         // Check that Alice fails backward the pending HTLC from the second payment.
3022         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3023         check_closed_broadcast!(nodes[0], true);
3024         check_added_monitors!(nodes[0], 1);
3025 }
3026
3027 #[test]
3028 fn test_htlc_ignore_latest_remote_commitment() {
3029         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3030         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3031         let chanmon_cfgs = create_chanmon_cfgs(2);
3032         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3033         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3034         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3035         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3036
3037         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3038         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3039         check_closed_broadcast!(nodes[0], false);
3040         check_added_monitors!(nodes[0], 1);
3041
3042         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3043         assert_eq!(node_txn.len(), 2);
3044
3045         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3046         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3047         check_closed_broadcast!(nodes[1], false);
3048         check_added_monitors!(nodes[1], 1);
3049
3050         // Duplicate the block_connected call since this may happen due to other listeners
3051         // registering new transactions
3052         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3053 }
3054
3055 #[test]
3056 fn test_force_close_fail_back() {
3057         // Check which HTLCs are failed-backwards on channel force-closure
3058         let chanmon_cfgs = create_chanmon_cfgs(3);
3059         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3060         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3061         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3062         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3063         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3064
3065         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
3066
3067         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3068
3069         let mut payment_event = {
3070                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
3071                 check_added_monitors!(nodes[0], 1);
3072
3073                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3074                 assert_eq!(events.len(), 1);
3075                 SendEvent::from_event(events.remove(0))
3076         };
3077
3078         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3079         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3080
3081         expect_pending_htlcs_forwardable!(nodes[1]);
3082
3083         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3084         assert_eq!(events_2.len(), 1);
3085         payment_event = SendEvent::from_event(events_2.remove(0));
3086         assert_eq!(payment_event.msgs.len(), 1);
3087
3088         check_added_monitors!(nodes[1], 1);
3089         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3090         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3091         check_added_monitors!(nodes[2], 1);
3092         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3093
3094         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3095         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3096         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3097
3098         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3099         check_closed_broadcast!(nodes[2], false);
3100         check_added_monitors!(nodes[2], 1);
3101         let tx = {
3102                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3103                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3104                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3105                 // back to nodes[1] upon timeout otherwise.
3106                 assert_eq!(node_txn.len(), 1);
3107                 node_txn.remove(0)
3108         };
3109
3110         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3111         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3112
3113         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3114         check_closed_broadcast!(nodes[1], false);
3115         check_added_monitors!(nodes[1], 1);
3116
3117         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3118         {
3119                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3120                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
3121                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3122         }
3123         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3124         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3125         assert_eq!(node_txn.len(), 1);
3126         assert_eq!(node_txn[0].input.len(), 1);
3127         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3128         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3129         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3130
3131         check_spends!(node_txn[0], tx);
3132 }
3133
3134 #[test]
3135 fn test_unconf_chan() {
3136         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3137         let chanmon_cfgs = create_chanmon_cfgs(2);
3138         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3139         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3140         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3141         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3142
3143         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3144         assert_eq!(channel_state.by_id.len(), 1);
3145         assert_eq!(channel_state.short_to_id.len(), 1);
3146         mem::drop(channel_state);
3147
3148         let mut headers = Vec::new();
3149         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3150         headers.push(header.clone());
3151         for _i in 2..100 {
3152                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3153                 headers.push(header.clone());
3154         }
3155         let mut height = 99;
3156         while !headers.is_empty() {
3157                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3158                 height -= 1;
3159         }
3160         check_closed_broadcast!(nodes[0], false);
3161         check_added_monitors!(nodes[0], 1);
3162         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3163         assert_eq!(channel_state.by_id.len(), 0);
3164         assert_eq!(channel_state.short_to_id.len(), 0);
3165 }
3166
3167 #[test]
3168 fn test_simple_peer_disconnect() {
3169         // Test that we can reconnect when there are no lost messages
3170         let chanmon_cfgs = create_chanmon_cfgs(3);
3171         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3172         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3173         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3174         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3175         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3176
3177         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3178         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3179         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3180
3181         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3182         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3183         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3184         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3185
3186         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3187         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3188         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3189
3190         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3191         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3192         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3193         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3194
3195         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3196         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3197
3198         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3199         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3200
3201         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3202         {
3203                 let events = nodes[0].node.get_and_clear_pending_events();
3204                 assert_eq!(events.len(), 2);
3205                 match events[0] {
3206                         Event::PaymentSent { payment_preimage } => {
3207                                 assert_eq!(payment_preimage, payment_preimage_3);
3208                         },
3209                         _ => panic!("Unexpected event"),
3210                 }
3211                 match events[1] {
3212                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3213                                 assert_eq!(payment_hash, payment_hash_5);
3214                                 assert!(rejected_by_dest);
3215                         },
3216                         _ => panic!("Unexpected event"),
3217                 }
3218         }
3219
3220         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3221         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3222 }
3223
3224 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3225         // Test that we can reconnect when in-flight HTLC updates get dropped
3226         let chanmon_cfgs = create_chanmon_cfgs(2);
3227         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3228         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3229         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3230         if messages_delivered == 0 {
3231                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3232                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3233         } else {
3234                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3235         }
3236
3237         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();
3238         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3239
3240         let payment_event = {
3241                 nodes[0].node.send_payment(&route, payment_hash_1, &None).unwrap();
3242                 check_added_monitors!(nodes[0], 1);
3243
3244                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3245                 assert_eq!(events.len(), 1);
3246                 SendEvent::from_event(events.remove(0))
3247         };
3248         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3249
3250         if messages_delivered < 2 {
3251                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3252         } else {
3253                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3254                 if messages_delivered >= 3 {
3255                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3256                         check_added_monitors!(nodes[1], 1);
3257                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3258
3259                         if messages_delivered >= 4 {
3260                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3261                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3262                                 check_added_monitors!(nodes[0], 1);
3263
3264                                 if messages_delivered >= 5 {
3265                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3266                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3267                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3268                                         check_added_monitors!(nodes[0], 1);
3269
3270                                         if messages_delivered >= 6 {
3271                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3272                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3273                                                 check_added_monitors!(nodes[1], 1);
3274                                         }
3275                                 }
3276                         }
3277                 }
3278         }
3279
3280         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3281         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3282         if messages_delivered < 3 {
3283                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3284                 // received on either side, both sides will need to resend them.
3285                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3286         } else if messages_delivered == 3 {
3287                 // nodes[0] still wants its RAA + commitment_signed
3288                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3289         } else if messages_delivered == 4 {
3290                 // nodes[0] still wants its commitment_signed
3291                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3292         } else if messages_delivered == 5 {
3293                 // nodes[1] still wants its final RAA
3294                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3295         } else if messages_delivered == 6 {
3296                 // Everything was delivered...
3297                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3298         }
3299
3300         let events_1 = nodes[1].node.get_and_clear_pending_events();
3301         assert_eq!(events_1.len(), 1);
3302         match events_1[0] {
3303                 Event::PendingHTLCsForwardable { .. } => { },
3304                 _ => panic!("Unexpected event"),
3305         };
3306
3307         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3308         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3309         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3310
3311         nodes[1].node.process_pending_htlc_forwards();
3312
3313         let events_2 = nodes[1].node.get_and_clear_pending_events();
3314         assert_eq!(events_2.len(), 1);
3315         match events_2[0] {
3316                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt } => {
3317                         assert_eq!(payment_hash_1, *payment_hash);
3318                         assert_eq!(*payment_secret, None);
3319                         assert_eq!(amt, 1000000);
3320                 },
3321                 _ => panic!("Unexpected event"),
3322         }
3323
3324         nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000);
3325         check_added_monitors!(nodes[1], 1);
3326
3327         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3328         assert_eq!(events_3.len(), 1);
3329         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3330                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3331                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3332                         assert!(updates.update_add_htlcs.is_empty());
3333                         assert!(updates.update_fail_htlcs.is_empty());
3334                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3335                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3336                         assert!(updates.update_fee.is_none());
3337                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3338                 },
3339                 _ => panic!("Unexpected event"),
3340         };
3341
3342         if messages_delivered >= 1 {
3343                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3344
3345                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3346                 assert_eq!(events_4.len(), 1);
3347                 match events_4[0] {
3348                         Event::PaymentSent { ref payment_preimage } => {
3349                                 assert_eq!(payment_preimage_1, *payment_preimage);
3350                         },
3351                         _ => panic!("Unexpected event"),
3352                 }
3353
3354                 if messages_delivered >= 2 {
3355                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3356                         check_added_monitors!(nodes[0], 1);
3357                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3358
3359                         if messages_delivered >= 3 {
3360                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3361                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3362                                 check_added_monitors!(nodes[1], 1);
3363
3364                                 if messages_delivered >= 4 {
3365                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3366                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3367                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3368                                         check_added_monitors!(nodes[1], 1);
3369
3370                                         if messages_delivered >= 5 {
3371                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3372                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3373                                                 check_added_monitors!(nodes[0], 1);
3374                                         }
3375                                 }
3376                         }
3377                 }
3378         }
3379
3380         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3381         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3382         if messages_delivered < 2 {
3383                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3384                 //TODO: Deduplicate PaymentSent events, then enable this if:
3385                 //if messages_delivered < 1 {
3386                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3387                         assert_eq!(events_4.len(), 1);
3388                         match events_4[0] {
3389                                 Event::PaymentSent { ref payment_preimage } => {
3390                                         assert_eq!(payment_preimage_1, *payment_preimage);
3391                                 },
3392                                 _ => panic!("Unexpected event"),
3393                         }
3394                 //}
3395         } else if messages_delivered == 2 {
3396                 // nodes[0] still wants its RAA + commitment_signed
3397                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3398         } else if messages_delivered == 3 {
3399                 // nodes[0] still wants its commitment_signed
3400                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3401         } else if messages_delivered == 4 {
3402                 // nodes[1] still wants its final RAA
3403                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3404         } else if messages_delivered == 5 {
3405                 // Everything was delivered...
3406                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3407         }
3408
3409         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3410         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3411         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3412
3413         // Channel should still work fine...
3414         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3415         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3416 }
3417
3418 #[test]
3419 fn test_drop_messages_peer_disconnect_a() {
3420         do_test_drop_messages_peer_disconnect(0);
3421         do_test_drop_messages_peer_disconnect(1);
3422         do_test_drop_messages_peer_disconnect(2);
3423         do_test_drop_messages_peer_disconnect(3);
3424 }
3425
3426 #[test]
3427 fn test_drop_messages_peer_disconnect_b() {
3428         do_test_drop_messages_peer_disconnect(4);
3429         do_test_drop_messages_peer_disconnect(5);
3430         do_test_drop_messages_peer_disconnect(6);
3431 }
3432
3433 #[test]
3434 fn test_funding_peer_disconnect() {
3435         // Test that we can lock in our funding tx while disconnected
3436         let chanmon_cfgs = create_chanmon_cfgs(2);
3437         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3438         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3439         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3440         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3441
3442         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3443         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3444
3445         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3446         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3447         assert_eq!(events_1.len(), 1);
3448         match events_1[0] {
3449                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3450                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3451                 },
3452                 _ => panic!("Unexpected event"),
3453         }
3454
3455         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3456
3457         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3458         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3459
3460         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3461         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3462         assert_eq!(events_2.len(), 2);
3463         let funding_locked = match events_2[0] {
3464                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3465                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3466                         msg.clone()
3467                 },
3468                 _ => panic!("Unexpected event"),
3469         };
3470         let bs_announcement_sigs = match events_2[1] {
3471                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3472                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3473                         msg.clone()
3474                 },
3475                 _ => panic!("Unexpected event"),
3476         };
3477
3478         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3479
3480         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3481         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3482         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3483         assert_eq!(events_3.len(), 2);
3484         let as_announcement_sigs = match events_3[0] {
3485                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3486                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3487                         msg.clone()
3488                 },
3489                 _ => panic!("Unexpected event"),
3490         };
3491         let (as_announcement, as_update) = match events_3[1] {
3492                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3493                         (msg.clone(), update_msg.clone())
3494                 },
3495                 _ => panic!("Unexpected event"),
3496         };
3497
3498         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3499         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3500         assert_eq!(events_4.len(), 1);
3501         let (_, bs_update) = match events_4[0] {
3502                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3503                         (msg.clone(), update_msg.clone())
3504                 },
3505                 _ => panic!("Unexpected event"),
3506         };
3507
3508         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3509         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3510         nodes[0].router.handle_channel_update(&as_update).unwrap();
3511
3512         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3513         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3514         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3515 }
3516
3517 #[test]
3518 fn test_drop_messages_peer_disconnect_dual_htlc() {
3519         // Test that we can handle reconnecting when both sides of a channel have pending
3520         // commitment_updates when we disconnect.
3521         let chanmon_cfgs = create_chanmon_cfgs(2);
3522         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3523         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3524         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3525         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3526
3527         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3528
3529         // Now try to send a second payment which will fail to send
3530         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3531         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3532
3533         nodes[0].node.send_payment(&route, payment_hash_2, &None).unwrap();
3534         check_added_monitors!(nodes[0], 1);
3535
3536         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3537         assert_eq!(events_1.len(), 1);
3538         match events_1[0] {
3539                 MessageSendEvent::UpdateHTLCs { .. } => {},
3540                 _ => panic!("Unexpected event"),
3541         }
3542
3543         assert!(nodes[1].node.claim_funds(payment_preimage_1, &None, 1_000_000));
3544         check_added_monitors!(nodes[1], 1);
3545
3546         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3547         assert_eq!(events_2.len(), 1);
3548         match events_2[0] {
3549                 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 } } => {
3550                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3551                         assert!(update_add_htlcs.is_empty());
3552                         assert_eq!(update_fulfill_htlcs.len(), 1);
3553                         assert!(update_fail_htlcs.is_empty());
3554                         assert!(update_fail_malformed_htlcs.is_empty());
3555                         assert!(update_fee.is_none());
3556
3557                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3558                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3559                         assert_eq!(events_3.len(), 1);
3560                         match events_3[0] {
3561                                 Event::PaymentSent { ref payment_preimage } => {
3562                                         assert_eq!(*payment_preimage, payment_preimage_1);
3563                                 },
3564                                 _ => panic!("Unexpected event"),
3565                         }
3566
3567                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3568                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3569                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3570                         check_added_monitors!(nodes[0], 1);
3571                 },
3572                 _ => panic!("Unexpected event"),
3573         }
3574
3575         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3576         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3577
3578         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3579         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3580         assert_eq!(reestablish_1.len(), 1);
3581         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3582         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3583         assert_eq!(reestablish_2.len(), 1);
3584
3585         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3586         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3587         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3588         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3589
3590         assert!(as_resp.0.is_none());
3591         assert!(bs_resp.0.is_none());
3592
3593         assert!(bs_resp.1.is_none());
3594         assert!(bs_resp.2.is_none());
3595
3596         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3597
3598         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3599         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3600         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3601         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3602         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3603         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3604         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3605         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3606         // No commitment_signed so get_event_msg's assert(len == 1) passes
3607         check_added_monitors!(nodes[1], 1);
3608
3609         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3610         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3611         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3612         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3613         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3614         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3615         assert!(bs_second_commitment_signed.update_fee.is_none());
3616         check_added_monitors!(nodes[1], 1);
3617
3618         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3619         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3620         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3621         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3622         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3623         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3624         assert!(as_commitment_signed.update_fee.is_none());
3625         check_added_monitors!(nodes[0], 1);
3626
3627         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3628         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3629         // No commitment_signed so get_event_msg's assert(len == 1) passes
3630         check_added_monitors!(nodes[0], 1);
3631
3632         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3633         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3634         // No commitment_signed so get_event_msg's assert(len == 1) passes
3635         check_added_monitors!(nodes[1], 1);
3636
3637         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3638         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3639         check_added_monitors!(nodes[1], 1);
3640
3641         expect_pending_htlcs_forwardable!(nodes[1]);
3642
3643         let events_5 = nodes[1].node.get_and_clear_pending_events();
3644         assert_eq!(events_5.len(), 1);
3645         match events_5[0] {
3646                 Event::PaymentReceived { ref payment_hash, ref payment_secret, amt: _ } => {
3647                         assert_eq!(payment_hash_2, *payment_hash);
3648                         assert_eq!(*payment_secret, None);
3649                 },
3650                 _ => panic!("Unexpected event"),
3651         }
3652
3653         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3654         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3655         check_added_monitors!(nodes[0], 1);
3656
3657         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3658 }
3659
3660 #[test]
3661 fn test_invalid_channel_announcement() {
3662         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3663         let secp_ctx = Secp256k1::new();
3664         let chanmon_cfgs = create_chanmon_cfgs(2);
3665         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3666         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3667         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3668
3669         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3670
3671         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3672         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3673         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3674         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3675
3676         nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3677
3678         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3679         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3680
3681         let as_network_key = nodes[0].node.get_our_node_id();
3682         let bs_network_key = nodes[1].node.get_our_node_id();
3683
3684         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3685
3686         let mut chan_announcement;
3687
3688         macro_rules! dummy_unsigned_msg {
3689                 () => {
3690                         msgs::UnsignedChannelAnnouncement {
3691                                 features: ChannelFeatures::supported(),
3692                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3693                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3694                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3695                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3696                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3697                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3698                                 excess_data: Vec::new(),
3699                         };
3700                 }
3701         }
3702
3703         macro_rules! sign_msg {
3704                 ($unsigned_msg: expr) => {
3705                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3706                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key());
3707                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key());
3708                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3709                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3710                         chan_announcement = msgs::ChannelAnnouncement {
3711                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3712                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3713                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3714                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3715                                 contents: $unsigned_msg
3716                         }
3717                 }
3718         }
3719
3720         let unsigned_msg = dummy_unsigned_msg!();
3721         sign_msg!(unsigned_msg);
3722         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3723         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 } );
3724
3725         // Configured with Network::Testnet
3726         let mut unsigned_msg = dummy_unsigned_msg!();
3727         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3728         sign_msg!(unsigned_msg);
3729         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3730
3731         let mut unsigned_msg = dummy_unsigned_msg!();
3732         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3733         sign_msg!(unsigned_msg);
3734         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3735 }
3736
3737 #[test]
3738 fn test_no_txn_manager_serialize_deserialize() {
3739         let chanmon_cfgs = create_chanmon_cfgs(2);
3740         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3741         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3742         let fee_estimator: test_utils::TestFeeEstimator;
3743         let new_chan_monitor: test_utils::TestChannelMonitor;
3744         let keys_manager: test_utils::TestKeysInterface;
3745         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3746         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3747
3748         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3749
3750         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3751
3752         let nodes_0_serialized = nodes[0].node.encode();
3753         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3754         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3755
3756         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3757         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);
3758         nodes[0].chan_monitor = &new_chan_monitor;
3759         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3760         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3761         assert!(chan_0_monitor_read.is_empty());
3762
3763         let mut nodes_0_read = &nodes_0_serialized[..];
3764         let config = UserConfig::default();
3765         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3766         let (_, nodes_0_deserialized_tmp) = {
3767                 let mut channel_monitors = HashMap::new();
3768                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3769                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3770                         default_config: config,
3771                         keys_manager: &keys_manager,
3772                         fee_estimator: &fee_estimator,
3773                         monitor: nodes[0].chan_monitor,
3774                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3775                         logger: Arc::new(test_utils::TestLogger::new()),
3776                         channel_monitors: &mut channel_monitors,
3777                 }).unwrap()
3778         };
3779         nodes_0_deserialized = nodes_0_deserialized_tmp;
3780         assert!(nodes_0_read.is_empty());
3781
3782         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3783         nodes[0].node = &nodes_0_deserialized;
3784         nodes[0].block_notifier.register_listener(nodes[0].node);
3785         assert_eq!(nodes[0].node.list_channels().len(), 1);
3786         check_added_monitors!(nodes[0], 1);
3787
3788         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3789         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3790         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3791         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3792
3793         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3794         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3795         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3796         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3797
3798         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3799         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3800         for node in nodes.iter() {
3801                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3802                 node.router.handle_channel_update(&as_update).unwrap();
3803                 node.router.handle_channel_update(&bs_update).unwrap();
3804         }
3805
3806         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3807 }
3808
3809 #[test]
3810 fn test_simple_manager_serialize_deserialize() {
3811         let chanmon_cfgs = create_chanmon_cfgs(2);
3812         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3813         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3814         let fee_estimator: test_utils::TestFeeEstimator;
3815         let new_chan_monitor: test_utils::TestChannelMonitor;
3816         let keys_manager: test_utils::TestKeysInterface;
3817         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3818         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3819         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3820
3821         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3822         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3823
3824         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3825
3826         let nodes_0_serialized = nodes[0].node.encode();
3827         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3828         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3829
3830         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3831         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);
3832         nodes[0].chan_monitor = &new_chan_monitor;
3833         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3834         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3835         assert!(chan_0_monitor_read.is_empty());
3836
3837         let mut nodes_0_read = &nodes_0_serialized[..];
3838         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3839         let (_, nodes_0_deserialized_tmp) = {
3840                 let mut channel_monitors = HashMap::new();
3841                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3842                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3843                         default_config: UserConfig::default(),
3844                         keys_manager: &keys_manager,
3845                         fee_estimator: &fee_estimator,
3846                         monitor: nodes[0].chan_monitor,
3847                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3848                         logger: Arc::new(test_utils::TestLogger::new()),
3849                         channel_monitors: &mut channel_monitors,
3850                 }).unwrap()
3851         };
3852         nodes_0_deserialized = nodes_0_deserialized_tmp;
3853         assert!(nodes_0_read.is_empty());
3854
3855         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3856         nodes[0].node = &nodes_0_deserialized;
3857         check_added_monitors!(nodes[0], 1);
3858
3859         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3860
3861         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3862         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3863 }
3864
3865 #[test]
3866 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3867         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3868         let chanmon_cfgs = create_chanmon_cfgs(4);
3869         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3870         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3871         let fee_estimator: test_utils::TestFeeEstimator;
3872         let new_chan_monitor: test_utils::TestChannelMonitor;
3873         let keys_manager: test_utils::TestKeysInterface;
3874         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3875         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3876         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3877         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3878         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3879
3880         let mut node_0_stale_monitors_serialized = Vec::new();
3881         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3882                 let mut writer = test_utils::TestVecWriter(Vec::new());
3883                 monitor.1.write_for_disk(&mut writer).unwrap();
3884                 node_0_stale_monitors_serialized.push(writer.0);
3885         }
3886
3887         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3888
3889         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3890         let nodes_0_serialized = nodes[0].node.encode();
3891
3892         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3893         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3894         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3895         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3896
3897         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3898         // nodes[3])
3899         let mut node_0_monitors_serialized = Vec::new();
3900         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3901                 let mut writer = test_utils::TestVecWriter(Vec::new());
3902                 monitor.1.write_for_disk(&mut writer).unwrap();
3903                 node_0_monitors_serialized.push(writer.0);
3904         }
3905
3906         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3907         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);
3908         nodes[0].chan_monitor = &new_chan_monitor;
3909
3910         let mut node_0_stale_monitors = Vec::new();
3911         for serialized in node_0_stale_monitors_serialized.iter() {
3912                 let mut read = &serialized[..];
3913                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3914                 assert!(read.is_empty());
3915                 node_0_stale_monitors.push(monitor);
3916         }
3917
3918         let mut node_0_monitors = Vec::new();
3919         for serialized in node_0_monitors_serialized.iter() {
3920                 let mut read = &serialized[..];
3921                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3922                 assert!(read.is_empty());
3923                 node_0_monitors.push(monitor);
3924         }
3925
3926         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3927
3928         let mut nodes_0_read = &nodes_0_serialized[..];
3929         if let Err(msgs::DecodeError::InvalidValue) =
3930                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3931                 default_config: UserConfig::default(),
3932                 keys_manager: &keys_manager,
3933                 fee_estimator: &fee_estimator,
3934                 monitor: nodes[0].chan_monitor,
3935                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3936                 logger: Arc::new(test_utils::TestLogger::new()),
3937                 channel_monitors: &mut node_0_stale_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3938         }) { } else {
3939                 panic!("If the monitor(s) are stale, this indicates a bug and we should get an Err return");
3940         };
3941
3942         let mut nodes_0_read = &nodes_0_serialized[..];
3943         let (_, nodes_0_deserialized_tmp) =
3944                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3945                 default_config: UserConfig::default(),
3946                 keys_manager: &keys_manager,
3947                 fee_estimator: &fee_estimator,
3948                 monitor: nodes[0].chan_monitor,
3949                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3950                 logger: Arc::new(test_utils::TestLogger::new()),
3951                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3952         }).unwrap();
3953         nodes_0_deserialized = nodes_0_deserialized_tmp;
3954         assert!(nodes_0_read.is_empty());
3955
3956         { // Channel close should result in a commitment tx and an HTLC tx
3957                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3958                 assert_eq!(txn.len(), 2);
3959                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3960                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3961         }
3962
3963         for monitor in node_0_monitors.drain(..) {
3964                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3965                 check_added_monitors!(nodes[0], 1);
3966         }
3967         nodes[0].node = &nodes_0_deserialized;
3968
3969         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3970         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3971         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3972         //... and we can even still claim the payment!
3973         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3974
3975         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3976         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3977         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3978         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3979         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3980         assert_eq!(msg_events.len(), 1);
3981         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3982                 match action {
3983                         &ErrorAction::SendErrorMessage { ref msg } => {
3984                                 assert_eq!(msg.channel_id, channel_id);
3985                         },
3986                         _ => panic!("Unexpected event!"),
3987                 }
3988         }
3989 }
3990
3991 macro_rules! check_spendable_outputs {
3992         ($node: expr, $der_idx: expr) => {
3993                 {
3994                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3995                         let mut txn = Vec::new();
3996                         for event in events {
3997                                 match event {
3998                                         Event::SpendableOutputs { ref outputs } => {
3999                                                 for outp in outputs {
4000                                                         match *outp {
4001                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
4002                                                                         let input = TxIn {
4003                                                                                 previous_output: outpoint.clone(),
4004                                                                                 script_sig: Script::new(),
4005                                                                                 sequence: 0,
4006                                                                                 witness: Vec::new(),
4007                                                                         };
4008                                                                         let outp = TxOut {
4009                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4010                                                                                 value: output.value,
4011                                                                         };
4012                                                                         let mut spend_tx = Transaction {
4013                                                                                 version: 2,
4014                                                                                 lock_time: 0,
4015                                                                                 input: vec![input],
4016                                                                                 output: vec![outp],
4017                                                                         };
4018                                                                         let secp_ctx = Secp256k1::new();
4019                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
4020                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4021                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4022                                                                         let remotesig = secp_ctx.sign(&sighash, key);
4023                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4024                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4025                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4026                                                                         txn.push(spend_tx);
4027                                                                 },
4028                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
4029                                                                         let input = TxIn {
4030                                                                                 previous_output: outpoint.clone(),
4031                                                                                 script_sig: Script::new(),
4032                                                                                 sequence: *to_self_delay as u32,
4033                                                                                 witness: Vec::new(),
4034                                                                         };
4035                                                                         let outp = TxOut {
4036                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4037                                                                                 value: output.value,
4038                                                                         };
4039                                                                         let mut spend_tx = Transaction {
4040                                                                                 version: 2,
4041                                                                                 lock_time: 0,
4042                                                                                 input: vec![input],
4043                                                                                 output: vec![outp],
4044                                                                         };
4045                                                                         let secp_ctx = Secp256k1::new();
4046                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
4047                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
4048                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
4049                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4050                                                                         spend_tx.input[0].witness.push(vec!());
4051                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4052                                                                         txn.push(spend_tx);
4053                                                                 },
4054                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4055                                                                         let secp_ctx = Secp256k1::new();
4056                                                                         let input = TxIn {
4057                                                                                 previous_output: outpoint.clone(),
4058                                                                                 script_sig: Script::new(),
4059                                                                                 sequence: 0,
4060                                                                                 witness: Vec::new(),
4061                                                                         };
4062                                                                         let outp = TxOut {
4063                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4064                                                                                 value: output.value,
4065                                                                         };
4066                                                                         let mut spend_tx = Transaction {
4067                                                                                 version: 2,
4068                                                                                 lock_time: 0,
4069                                                                                 input: vec![input],
4070                                                                                 output: vec![outp.clone()],
4071                                                                         };
4072                                                                         let secret = {
4073                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4074                                                                                         Ok(master_key) => {
4075                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4076                                                                                                         Ok(key) => key,
4077                                                                                                         Err(_) => panic!("Your RNG is busted"),
4078                                                                                                 }
4079                                                                                         }
4080                                                                                         Err(_) => panic!("Your rng is busted"),
4081                                                                                 }
4082                                                                         };
4083                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4084                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4085                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4086                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4087                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4088                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4089                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4090                                                                         txn.push(spend_tx);
4091                                                                 },
4092                                                         }
4093                                                 }
4094                                         },
4095                                         _ => panic!("Unexpected event"),
4096                                 };
4097                         }
4098                         txn
4099                 }
4100         }
4101 }
4102
4103 #[test]
4104 fn test_claim_sizeable_push_msat() {
4105         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4106         let chanmon_cfgs = create_chanmon_cfgs(2);
4107         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4108         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4109         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4110
4111         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4112         nodes[1].node.force_close_channel(&chan.2);
4113         check_closed_broadcast!(nodes[1], false);
4114         check_added_monitors!(nodes[1], 1);
4115         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4116         assert_eq!(node_txn.len(), 1);
4117         check_spends!(node_txn[0], chan.3);
4118         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
4119
4120         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4121         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4122         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4123
4124         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4125         assert_eq!(spend_txn.len(), 1);
4126         check_spends!(spend_txn[0], node_txn[0]);
4127 }
4128
4129 #[test]
4130 fn test_claim_on_remote_sizeable_push_msat() {
4131         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4132         // to_remote output is encumbered by a P2WPKH
4133         let chanmon_cfgs = create_chanmon_cfgs(2);
4134         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4135         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4136         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4137
4138         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4139         nodes[0].node.force_close_channel(&chan.2);
4140         check_closed_broadcast!(nodes[0], false);
4141         check_added_monitors!(nodes[0], 1);
4142
4143         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4144         assert_eq!(node_txn.len(), 1);
4145         check_spends!(node_txn[0], chan.3);
4146         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
4147
4148         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4149         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4150         check_closed_broadcast!(nodes[1], false);
4151         check_added_monitors!(nodes[1], 1);
4152         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4153
4154         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4155         assert_eq!(spend_txn.len(), 2);
4156         assert_eq!(spend_txn[0], spend_txn[1]);
4157         check_spends!(spend_txn[0], node_txn[0]);
4158 }
4159
4160 #[test]
4161 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4162         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4163         // to_remote output is encumbered by a P2WPKH
4164
4165         let chanmon_cfgs = create_chanmon_cfgs(2);
4166         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4167         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4168         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4169
4170         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
4171         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4172         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4173         assert_eq!(revoked_local_txn[0].input.len(), 1);
4174         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4175
4176         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4177         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4178         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4179         check_closed_broadcast!(nodes[1], false);
4180         check_added_monitors!(nodes[1], 1);
4181
4182         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4183         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4184         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4185         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4186
4187         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4188         assert_eq!(spend_txn.len(), 3);
4189         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4190         check_spends!(spend_txn[0], revoked_local_txn[0]);
4191         check_spends!(spend_txn[2], node_txn[0]);
4192 }
4193
4194 #[test]
4195 fn test_static_spendable_outputs_preimage_tx() {
4196         let chanmon_cfgs = create_chanmon_cfgs(2);
4197         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4198         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4199         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4200
4201         // Create some initial channels
4202         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4203
4204         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4205
4206         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4207         assert_eq!(commitment_tx[0].input.len(), 1);
4208         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4209
4210         // Settle A's commitment tx on B's chain
4211         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4212         assert!(nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000));
4213         check_added_monitors!(nodes[1], 1);
4214         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4215         check_added_monitors!(nodes[1], 1);
4216         let events = nodes[1].node.get_and_clear_pending_msg_events();
4217         match events[0] {
4218                 MessageSendEvent::UpdateHTLCs { .. } => {},
4219                 _ => panic!("Unexpected event"),
4220         }
4221         match events[1] {
4222                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4223                 _ => panic!("Unexepected event"),
4224         }
4225
4226         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4227         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4228         assert_eq!(node_txn.len(), 3);
4229         check_spends!(node_txn[0], commitment_tx[0]);
4230         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4231         check_spends!(node_txn[1], chan_1.3);
4232         check_spends!(node_txn[2], node_txn[1]);
4233
4234         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4235         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4236         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4237
4238         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4239         assert_eq!(spend_txn.len(), 1);
4240         check_spends!(spend_txn[0], node_txn[0]);
4241 }
4242
4243 #[test]
4244 fn test_static_spendable_outputs_timeout_tx() {
4245         let chanmon_cfgs = create_chanmon_cfgs(2);
4246         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4247         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4248         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4249
4250         // Create some initial channels
4251         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4252
4253         // Rebalance the network a bit by relaying one payment through all the channels ...
4254         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4255
4256         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4257
4258         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4259         assert_eq!(commitment_tx[0].input.len(), 1);
4260         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4261
4262         // Settle A's commitment tx on B' chain
4263         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4264         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4265         check_added_monitors!(nodes[1], 1);
4266         let events = nodes[1].node.get_and_clear_pending_msg_events();
4267         match events[0] {
4268                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4269                 _ => panic!("Unexpected event"),
4270         }
4271
4272         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4273         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4274         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4275         check_spends!(node_txn[0],  commitment_tx[0].clone());
4276         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4277         check_spends!(node_txn[1], chan_1.3.clone());
4278         check_spends!(node_txn[2], node_txn[1]);
4279
4280         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4281         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4282         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4283         let events = nodes[1].node.get_and_clear_pending_events();
4284         assert_eq!(events.len(), 1);
4285         match events[0] {
4286                 Event::PaymentFailed { payment_hash, .. } => {
4287                         assert_eq!(payment_hash, our_payment_hash);
4288                 },
4289                 _ => panic!("Unexpected event"),
4290         }
4291
4292         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4293         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4294         check_spends!(spend_txn[2], node_txn[0].clone());
4295 }
4296
4297 #[test]
4298 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4299         let chanmon_cfgs = create_chanmon_cfgs(2);
4300         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4301         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4302         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4303
4304         // Create some initial channels
4305         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4306
4307         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4308         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4309         assert_eq!(revoked_local_txn[0].input.len(), 1);
4310         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4311
4312         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4313
4314         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4315         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4316         check_closed_broadcast!(nodes[1], false);
4317         check_added_monitors!(nodes[1], 1);
4318
4319         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4320         assert_eq!(node_txn.len(), 2);
4321         assert_eq!(node_txn[0].input.len(), 2);
4322         check_spends!(node_txn[0], revoked_local_txn[0]);
4323
4324         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4325         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4326         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4327
4328         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4329         assert_eq!(spend_txn.len(), 1);
4330         check_spends!(spend_txn[0], node_txn[0]);
4331 }
4332
4333 #[test]
4334 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4335         let chanmon_cfgs = create_chanmon_cfgs(2);
4336         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4337         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4338         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4339
4340         // Create some initial channels
4341         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4342
4343         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4344         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4345         assert_eq!(revoked_local_txn[0].input.len(), 1);
4346         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4347
4348         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4349
4350         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4351         // A will generate HTLC-Timeout from revoked commitment tx
4352         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4353         check_closed_broadcast!(nodes[0], false);
4354         check_added_monitors!(nodes[0], 1);
4355
4356         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4357         assert_eq!(revoked_htlc_txn.len(), 3);
4358         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4359         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4360         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4361         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4362         check_spends!(revoked_htlc_txn[1], chan_1.3);
4363
4364         // B will generate justice tx from A's revoked commitment/HTLC tx
4365         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4366         check_closed_broadcast!(nodes[1], false);
4367         check_added_monitors!(nodes[1], 1);
4368
4369         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4370         assert_eq!(node_txn.len(), 4); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-timeout, adjusted justice tx, ChannelManager: local commitment tx
4371         assert_eq!(node_txn[0].input.len(), 2);
4372         check_spends!(node_txn[0], revoked_local_txn[0]);
4373         check_spends!(node_txn[1], chan_1.3);
4374         assert_eq!(node_txn[2].input.len(), 1);
4375         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4376         assert_eq!(node_txn[3].input.len(), 1);
4377         check_spends!(node_txn[3], revoked_local_txn[0]);
4378
4379         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4380         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4381         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4382
4383         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4384         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4385         assert_eq!(spend_txn.len(), 2);
4386         check_spends!(spend_txn[0], node_txn[0]);
4387         check_spends!(spend_txn[1], node_txn[2]);
4388 }
4389
4390 #[test]
4391 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4392         let chanmon_cfgs = create_chanmon_cfgs(2);
4393         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4394         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4395         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4396
4397         // Create some initial channels
4398         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4399
4400         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4401         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4402         assert_eq!(revoked_local_txn[0].input.len(), 1);
4403         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4404
4405         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4406
4407         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4408         // B will generate HTLC-Success from revoked commitment tx
4409         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4410         check_closed_broadcast!(nodes[1], false);
4411         check_added_monitors!(nodes[1], 1);
4412         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4413
4414         assert_eq!(revoked_htlc_txn.len(), 3);
4415         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4416         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4417         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4418         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4419
4420         // A will generate justice tx from B's revoked commitment/HTLC tx
4421         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4422         check_closed_broadcast!(nodes[0], false);
4423         check_added_monitors!(nodes[0], 1);
4424
4425         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4426         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4427         assert_eq!(node_txn[2].input.len(), 1);
4428         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4429
4430         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4431         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4432         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4433
4434         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4435         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4436         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
4437         assert_eq!(spend_txn[0], spend_txn[1]);
4438         assert_eq!(spend_txn[0], spend_txn[2]);
4439         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4440         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
4441         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
4442 }
4443
4444 #[test]
4445 fn test_onchain_to_onchain_claim() {
4446         // Test that in case of channel closure, we detect the state of output thanks to
4447         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4448         // First, have C claim an HTLC against its own latest commitment transaction.
4449         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4450         // channel.
4451         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4452         // gets broadcast.
4453
4454         let chanmon_cfgs = create_chanmon_cfgs(3);
4455         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4456         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4457         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4458
4459         // Create some initial channels
4460         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4461         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4462
4463         // Rebalance the network a bit by relaying one payment through all the channels ...
4464         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4465         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4466
4467         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4468         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4469         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4470         check_spends!(commitment_tx[0], chan_2.3);
4471         nodes[2].node.claim_funds(payment_preimage, &None, 3_000_000);
4472         check_added_monitors!(nodes[2], 1);
4473         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4474         assert!(updates.update_add_htlcs.is_empty());
4475         assert!(updates.update_fail_htlcs.is_empty());
4476         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4477         assert!(updates.update_fail_malformed_htlcs.is_empty());
4478
4479         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4480         check_closed_broadcast!(nodes[2], false);
4481         check_added_monitors!(nodes[2], 1);
4482
4483         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4484         assert_eq!(c_txn.len(), 3);
4485         assert_eq!(c_txn[0], c_txn[2]);
4486         assert_eq!(commitment_tx[0], c_txn[1]);
4487         check_spends!(c_txn[1], chan_2.3);
4488         check_spends!(c_txn[2], c_txn[1]);
4489         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4490         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4491         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4492         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4493
4494         // 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
4495         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4496         {
4497                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4498                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4499                 assert_eq!(b_txn.len(), 3);
4500                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4501                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4502                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4503                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4504                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4505                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4506                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4507                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4508                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4509                 b_txn.clear();
4510         }
4511         check_added_monitors!(nodes[1], 1);
4512         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4513         check_added_monitors!(nodes[1], 1);
4514         match msg_events[0] {
4515                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4516                 _ => panic!("Unexpected event"),
4517         }
4518         match msg_events[1] {
4519                 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, .. } } => {
4520                         assert!(update_add_htlcs.is_empty());
4521                         assert!(update_fail_htlcs.is_empty());
4522                         assert_eq!(update_fulfill_htlcs.len(), 1);
4523                         assert!(update_fail_malformed_htlcs.is_empty());
4524                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4525                 },
4526                 _ => panic!("Unexpected event"),
4527         };
4528         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4529         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4530         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4531         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4532         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4533         assert_eq!(b_txn.len(), 3);
4534         check_spends!(b_txn[1], chan_1.3);
4535         check_spends!(b_txn[2], b_txn[1]);
4536         check_spends!(b_txn[0], commitment_tx[0]);
4537         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4538         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4539         assert_eq!(b_txn[0].lock_time, 0); // Success tx
4540
4541         check_closed_broadcast!(nodes[1], false);
4542         check_added_monitors!(nodes[1], 1);
4543 }
4544
4545 #[test]
4546 fn test_duplicate_payment_hash_one_failure_one_success() {
4547         // Topology : A --> B --> C
4548         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4549         let chanmon_cfgs = create_chanmon_cfgs(3);
4550         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4551         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4552         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4553
4554         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4555         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4556
4557         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4558         *nodes[0].network_payment_count.borrow_mut() -= 1;
4559         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4560
4561         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
4562         assert_eq!(commitment_txn[0].input.len(), 1);
4563         check_spends!(commitment_txn[0], chan_2.3);
4564
4565         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4566         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4567         check_closed_broadcast!(nodes[1], false);
4568         check_added_monitors!(nodes[1], 1);
4569
4570         let htlc_timeout_tx;
4571         { // Extract one of the two HTLC-Timeout transaction
4572                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4573                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
4574                 assert_eq!(node_txn.len(), 5);
4575                 check_spends!(node_txn[0], commitment_txn[0]);
4576                 assert_eq!(node_txn[0].input.len(), 1);
4577                 check_spends!(node_txn[1], commitment_txn[0]);
4578                 assert_eq!(node_txn[1].input.len(), 1);
4579                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4580                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4581                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4582                 check_spends!(node_txn[2], chan_2.3);
4583                 check_spends!(node_txn[3], node_txn[2]);
4584                 check_spends!(node_txn[4], node_txn[2]);
4585                 htlc_timeout_tx = node_txn[1].clone();
4586         }
4587
4588         nodes[2].node.claim_funds(our_payment_preimage, &None, 900_000);
4589         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4590         check_added_monitors!(nodes[2], 3);
4591         let events = nodes[2].node.get_and_clear_pending_msg_events();
4592         match events[0] {
4593                 MessageSendEvent::UpdateHTLCs { .. } => {},
4594                 _ => panic!("Unexpected event"),
4595         }
4596         match events[1] {
4597                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4598                 _ => panic!("Unexepected event"),
4599         }
4600         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4601         assert_eq!(htlc_success_txn.len(), 5); // ChannelMonitor: HTLC-Success txn (*2 due to 2-HTLC outputs), ChannelManager: local commitment tx + HTLC-Success txn (*2 due to 2-HTLC outputs)
4602         check_spends!(htlc_success_txn[2], chan_2.3);
4603         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4604         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4605         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
4606         assert_eq!(htlc_success_txn[0].input.len(), 1);
4607         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4608         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4609         assert_eq!(htlc_success_txn[1].input.len(), 1);
4610         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4611         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4612         check_spends!(htlc_success_txn[0], commitment_txn[0]);
4613         check_spends!(htlc_success_txn[1], commitment_txn[0]);
4614
4615         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4616         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4617         expect_pending_htlcs_forwardable!(nodes[1]);
4618         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4619         assert!(htlc_updates.update_add_htlcs.is_empty());
4620         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4621         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4622         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4623         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4624         check_added_monitors!(nodes[1], 1);
4625
4626         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4627         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4628         {
4629                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4630                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4631                 assert_eq!(events.len(), 1);
4632                 match events[0] {
4633                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4634                         },
4635                         _ => { panic!("Unexpected event"); }
4636                 }
4637         }
4638         let events = nodes[0].node.get_and_clear_pending_events();
4639         match events[0] {
4640                 Event::PaymentFailed { ref payment_hash, .. } => {
4641                         assert_eq!(*payment_hash, duplicate_payment_hash);
4642                 }
4643                 _ => panic!("Unexpected event"),
4644         }
4645
4646         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4647         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4648         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4649         assert!(updates.update_add_htlcs.is_empty());
4650         assert!(updates.update_fail_htlcs.is_empty());
4651         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4652         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4653         assert!(updates.update_fail_malformed_htlcs.is_empty());
4654         check_added_monitors!(nodes[1], 1);
4655
4656         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4657         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4658
4659         let events = nodes[0].node.get_and_clear_pending_events();
4660         match events[0] {
4661                 Event::PaymentSent { ref payment_preimage } => {
4662                         assert_eq!(*payment_preimage, our_payment_preimage);
4663                 }
4664                 _ => panic!("Unexpected event"),
4665         }
4666 }
4667
4668 #[test]
4669 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4670         let chanmon_cfgs = create_chanmon_cfgs(2);
4671         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4672         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4673         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4674
4675         // Create some initial channels
4676         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4677
4678         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4679         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4680         assert_eq!(local_txn[0].input.len(), 1);
4681         check_spends!(local_txn[0], chan_1.3);
4682
4683         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4684         nodes[1].node.claim_funds(payment_preimage, &None, 9_000_000);
4685         check_added_monitors!(nodes[1], 1);
4686         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4687         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4688         check_added_monitors!(nodes[1], 1);
4689         let events = nodes[1].node.get_and_clear_pending_msg_events();
4690         match events[0] {
4691                 MessageSendEvent::UpdateHTLCs { .. } => {},
4692                 _ => panic!("Unexpected event"),
4693         }
4694         match events[1] {
4695                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4696                 _ => panic!("Unexepected event"),
4697         }
4698         let node_txn = {
4699                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4700                 assert_eq!(node_txn[0].input.len(), 1);
4701                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4702                 check_spends!(node_txn[0], local_txn[0]);
4703                 vec![node_txn[0].clone(), node_txn[2].clone()]
4704         };
4705
4706         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4707         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
4708         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
4709
4710         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4711         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4712         assert_eq!(spend_txn.len(), 2);
4713         check_spends!(spend_txn[0], node_txn[0]);
4714         check_spends!(spend_txn[1], node_txn[1]);
4715 }
4716
4717 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4718         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4719         // unrevoked commitment transaction.
4720         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4721         // a remote RAA before they could be failed backwards (and combinations thereof).
4722         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4723         // use the same payment hashes.
4724         // Thus, we use a six-node network:
4725         //
4726         // A \         / E
4727         //    - C - D -
4728         // B /         \ F
4729         // And test where C fails back to A/B when D announces its latest commitment transaction
4730         let chanmon_cfgs = create_chanmon_cfgs(6);
4731         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4732         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4733         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4734
4735         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4736         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4737         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4738         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4739         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4740
4741         // Rebalance and check output sanity...
4742         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4743         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4744         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
4745
4746         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4747         // 0th HTLC:
4748         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
4749         // 1st HTLC:
4750         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
4751         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();
4752         // 2nd HTLC:
4753         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
4754         // 3rd HTLC:
4755         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
4756         // 4th HTLC:
4757         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4758         // 5th HTLC:
4759         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4760         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4761         // 6th HTLC:
4762         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4763         // 7th HTLC:
4764         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4765
4766         // 8th HTLC:
4767         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4768         // 9th HTLC:
4769         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();
4770         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
4771
4772         // 10th HTLC:
4773         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
4774         // 11th HTLC:
4775         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4776         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4777
4778         // Double-check that six of the new HTLC were added
4779         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4780         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4781         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
4782         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
4783
4784         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4785         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4786         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1, &None));
4787         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3, &None));
4788         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5, &None));
4789         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6, &None));
4790         check_added_monitors!(nodes[4], 0);
4791         expect_pending_htlcs_forwardable!(nodes[4]);
4792         check_added_monitors!(nodes[4], 1);
4793
4794         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4795         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4796         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4797         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4798         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4799         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4800
4801         // Fail 3rd below-dust and 7th above-dust HTLCs
4802         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2, &None));
4803         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4, &None));
4804         check_added_monitors!(nodes[5], 0);
4805         expect_pending_htlcs_forwardable!(nodes[5]);
4806         check_added_monitors!(nodes[5], 1);
4807
4808         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4809         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4810         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4811         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4812
4813         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4814
4815         expect_pending_htlcs_forwardable!(nodes[3]);
4816         check_added_monitors!(nodes[3], 1);
4817         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4818         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4819         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4820         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4821         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4822         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4823         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4824         if deliver_last_raa {
4825                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4826         } else {
4827                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4828         }
4829
4830         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4831         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4832         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4833         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4834         //
4835         // We now broadcast the latest commitment transaction, which *should* result in failures for
4836         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4837         // the non-broadcast above-dust HTLCs.
4838         //
4839         // Alternatively, we may broadcast the previous commitment transaction, which should only
4840         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4841         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4842
4843         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4844         if announce_latest {
4845                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4846         } else {
4847                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4848         }
4849         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4850         check_closed_broadcast!(nodes[2], false);
4851         expect_pending_htlcs_forwardable!(nodes[2]);
4852         check_added_monitors!(nodes[2], 3);
4853
4854         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4855         assert_eq!(cs_msgs.len(), 2);
4856         let mut a_done = false;
4857         for msg in cs_msgs {
4858                 match msg {
4859                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4860                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4861                                 // should be failed-backwards here.
4862                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4863                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4864                                         for htlc in &updates.update_fail_htlcs {
4865                                                 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 });
4866                                         }
4867                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4868                                         assert!(!a_done);
4869                                         a_done = true;
4870                                         &nodes[0]
4871                                 } else {
4872                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4873                                         for htlc in &updates.update_fail_htlcs {
4874                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4875                                         }
4876                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4877                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4878                                         &nodes[1]
4879                                 };
4880                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4881                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4882                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4883                                 if announce_latest {
4884                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4885                                         if *node_id == nodes[0].node.get_our_node_id() {
4886                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4887                                         }
4888                                 }
4889                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4890                         },
4891                         _ => panic!("Unexpected event"),
4892                 }
4893         }
4894
4895         let as_events = nodes[0].node.get_and_clear_pending_events();
4896         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4897         let mut as_failds = HashSet::new();
4898         for event in as_events.iter() {
4899                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4900                         assert!(as_failds.insert(*payment_hash));
4901                         if *payment_hash != payment_hash_2 {
4902                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4903                         } else {
4904                                 assert!(!rejected_by_dest);
4905                         }
4906                 } else { panic!("Unexpected event"); }
4907         }
4908         assert!(as_failds.contains(&payment_hash_1));
4909         assert!(as_failds.contains(&payment_hash_2));
4910         if announce_latest {
4911                 assert!(as_failds.contains(&payment_hash_3));
4912                 assert!(as_failds.contains(&payment_hash_5));
4913         }
4914         assert!(as_failds.contains(&payment_hash_6));
4915
4916         let bs_events = nodes[1].node.get_and_clear_pending_events();
4917         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4918         let mut bs_failds = HashSet::new();
4919         for event in bs_events.iter() {
4920                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4921                         assert!(bs_failds.insert(*payment_hash));
4922                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4923                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4924                         } else {
4925                                 assert!(!rejected_by_dest);
4926                         }
4927                 } else { panic!("Unexpected event"); }
4928         }
4929         assert!(bs_failds.contains(&payment_hash_1));
4930         assert!(bs_failds.contains(&payment_hash_2));
4931         if announce_latest {
4932                 assert!(bs_failds.contains(&payment_hash_4));
4933         }
4934         assert!(bs_failds.contains(&payment_hash_5));
4935
4936         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4937         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4938         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4939         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4940         // PaymentFailureNetworkUpdates.
4941         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4942         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4943         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4944         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4945         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4946                 match event {
4947                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4948                         _ => panic!("Unexpected event"),
4949                 }
4950         }
4951 }
4952
4953 #[test]
4954 fn test_fail_backwards_latest_remote_announce_a() {
4955         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4956 }
4957
4958 #[test]
4959 fn test_fail_backwards_latest_remote_announce_b() {
4960         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4961 }
4962
4963 #[test]
4964 fn test_fail_backwards_previous_remote_announce() {
4965         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4966         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4967         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4968 }
4969
4970 #[test]
4971 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4972         let chanmon_cfgs = create_chanmon_cfgs(2);
4973         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4974         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4975         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4976
4977         // Create some initial channels
4978         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4979
4980         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
4981         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4982         assert_eq!(local_txn[0].input.len(), 1);
4983         check_spends!(local_txn[0], chan_1.3);
4984
4985         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4986         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4987         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4988         check_closed_broadcast!(nodes[0], false);
4989         check_added_monitors!(nodes[0], 1);
4990
4991         let htlc_timeout = {
4992                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4993                 assert_eq!(node_txn[0].input.len(), 1);
4994                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4995                 check_spends!(node_txn[0], local_txn[0]);
4996                 node_txn[0].clone()
4997         };
4998
4999         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5000         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5001         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5002         let events = nodes[0].node.get_and_clear_pending_events();
5003         assert_eq!(events.len(), 1);
5004         match events[0] {
5005                 Event::PaymentFailed { payment_hash, .. } => {
5006                         assert_eq!(payment_hash, our_payment_hash);
5007                 },
5008                 _ => panic!("Unexpected event"),
5009         }
5010
5011         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5012         let spend_txn = check_spendable_outputs!(nodes[0], 1);
5013         assert_eq!(spend_txn.len(), 3);
5014         assert_eq!(spend_txn[0], spend_txn[1]);
5015         check_spends!(spend_txn[0], local_txn[0]);
5016         check_spends!(spend_txn[2], htlc_timeout);
5017 }
5018
5019 #[test]
5020 fn test_static_output_closing_tx() {
5021         let chanmon_cfgs = create_chanmon_cfgs(2);
5022         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5023         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5024         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5025
5026         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5027
5028         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5029         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5030
5031         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5032         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5033         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5034
5035         let spend_txn = check_spendable_outputs!(nodes[0], 2);
5036         assert_eq!(spend_txn.len(), 1);
5037         check_spends!(spend_txn[0], closing_tx);
5038
5039         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5040         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5041
5042         let spend_txn = check_spendable_outputs!(nodes[1], 2);
5043         assert_eq!(spend_txn.len(), 1);
5044         check_spends!(spend_txn[0], closing_tx);
5045 }
5046
5047 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5048         let chanmon_cfgs = create_chanmon_cfgs(2);
5049         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5050         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5051         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5052         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5053
5054         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5055
5056         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5057         // present in B's local commitment transaction, but none of A's commitment transactions.
5058         assert!(nodes[1].node.claim_funds(our_payment_preimage, &None, if use_dust { 50_000 } else { 3_000_000 }));
5059         check_added_monitors!(nodes[1], 1);
5060
5061         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5062         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5063         let events = nodes[0].node.get_and_clear_pending_events();
5064         assert_eq!(events.len(), 1);
5065         match events[0] {
5066                 Event::PaymentSent { payment_preimage } => {
5067                         assert_eq!(payment_preimage, our_payment_preimage);
5068                 },
5069                 _ => panic!("Unexpected event"),
5070         }
5071
5072         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5073         check_added_monitors!(nodes[0], 1);
5074         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5075         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5076         check_added_monitors!(nodes[1], 1);
5077
5078         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5079         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5080                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5081                 header.prev_blockhash = header.bitcoin_hash();
5082         }
5083         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5084         check_closed_broadcast!(nodes[1], false);
5085         check_added_monitors!(nodes[1], 1);
5086 }
5087
5088 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5089         let chanmon_cfgs = create_chanmon_cfgs(2);
5090         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5091         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5092         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5093         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5094
5095         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();
5096         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5097         nodes[0].node.send_payment(&route, payment_hash, &None).unwrap();
5098         check_added_monitors!(nodes[0], 1);
5099
5100         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5101
5102         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5103         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5104         // to "time out" the HTLC.
5105
5106         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5107
5108         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5109                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5110                 header.prev_blockhash = header.bitcoin_hash();
5111         }
5112         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5113         check_closed_broadcast!(nodes[0], false);
5114         check_added_monitors!(nodes[0], 1);
5115 }
5116
5117 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5118         let chanmon_cfgs = create_chanmon_cfgs(3);
5119         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5120         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5121         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5122         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5123
5124         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5125         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5126         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5127         // actually revoked.
5128         let htlc_value = if use_dust { 50000 } else { 3000000 };
5129         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5130         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash, &None));
5131         expect_pending_htlcs_forwardable!(nodes[1]);
5132         check_added_monitors!(nodes[1], 1);
5133
5134         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5135         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5136         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5137         check_added_monitors!(nodes[0], 1);
5138         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5139         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5140         check_added_monitors!(nodes[1], 1);
5141         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5142         check_added_monitors!(nodes[1], 1);
5143         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5144
5145         if check_revoke_no_close {
5146                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5147                 check_added_monitors!(nodes[0], 1);
5148         }
5149
5150         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5151         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5152                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5153                 header.prev_blockhash = header.bitcoin_hash();
5154         }
5155         if !check_revoke_no_close {
5156                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5157                 check_closed_broadcast!(nodes[0], false);
5158                 check_added_monitors!(nodes[0], 1);
5159         } else {
5160                 let events = nodes[0].node.get_and_clear_pending_events();
5161                 assert_eq!(events.len(), 1);
5162                 match events[0] {
5163                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
5164                                 assert_eq!(payment_hash, our_payment_hash);
5165                                 assert!(rejected_by_dest);
5166                         },
5167                         _ => panic!("Unexpected event"),
5168                 }
5169         }
5170 }
5171
5172 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5173 // There are only a few cases to test here:
5174 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5175 //    broadcastable commitment transactions result in channel closure,
5176 //  * its included in an unrevoked-but-previous remote commitment transaction,
5177 //  * its included in the latest remote or local commitment transactions.
5178 // We test each of the three possible commitment transactions individually and use both dust and
5179 // non-dust HTLCs.
5180 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5181 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5182 // tested for at least one of the cases in other tests.
5183 #[test]
5184 fn htlc_claim_single_commitment_only_a() {
5185         do_htlc_claim_local_commitment_only(true);
5186         do_htlc_claim_local_commitment_only(false);
5187
5188         do_htlc_claim_current_remote_commitment_only(true);
5189         do_htlc_claim_current_remote_commitment_only(false);
5190 }
5191
5192 #[test]
5193 fn htlc_claim_single_commitment_only_b() {
5194         do_htlc_claim_previous_remote_commitment_only(true, false);
5195         do_htlc_claim_previous_remote_commitment_only(false, false);
5196         do_htlc_claim_previous_remote_commitment_only(true, true);
5197         do_htlc_claim_previous_remote_commitment_only(false, true);
5198 }
5199
5200 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>)
5201         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5202                                 F2: FnMut(),
5203 {
5204         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);
5205 }
5206
5207 // test_case
5208 // 0: node1 fails backward
5209 // 1: final node fails backward
5210 // 2: payment completed but the user rejects the payment
5211 // 3: final node fails backward (but tamper onion payloads from node0)
5212 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5213 // 200: trigger error in the final node and tamper returning fail_htlc
5214 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>)
5215         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5216                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5217                                 F3: FnMut(),
5218 {
5219
5220         // reset block height
5221         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5222         for ix in 0..nodes.len() {
5223                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5224         }
5225
5226         macro_rules! expect_event {
5227                 ($node: expr, $event_type: path) => {{
5228                         let events = $node.node.get_and_clear_pending_events();
5229                         assert_eq!(events.len(), 1);
5230                         match events[0] {
5231                                 $event_type { .. } => {},
5232                                 _ => panic!("Unexpected event"),
5233                         }
5234                 }}
5235         }
5236
5237         macro_rules! expect_htlc_forward {
5238                 ($node: expr) => {{
5239                         expect_event!($node, Event::PendingHTLCsForwardable);
5240                         $node.node.process_pending_htlc_forwards();
5241                 }}
5242         }
5243
5244         // 0 ~~> 2 send payment
5245         nodes[0].node.send_payment(&route, payment_hash.clone(), &None).unwrap();
5246         check_added_monitors!(nodes[0], 1);
5247         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5248         // temper update_add (0 => 1)
5249         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5250         if test_case == 0 || test_case == 3 || test_case == 100 {
5251                 callback_msg(&mut update_add_0);
5252                 callback_node();
5253         }
5254         // 0 => 1 update_add & CS
5255         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5256         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5257
5258         let update_1_0 = match test_case {
5259                 0|100 => { // intermediate node failure; fail backward to 0
5260                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5261                         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));
5262                         update_1_0
5263                 },
5264                 1|2|3|200 => { // final node failure; forwarding to 2
5265                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5266                         // forwarding on 1
5267                         if test_case != 200 {
5268                                 callback_node();
5269                         }
5270                         expect_htlc_forward!(&nodes[1]);
5271
5272                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5273                         check_added_monitors!(&nodes[1], 1);
5274                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5275                         // tamper update_add (1 => 2)
5276                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5277                         if test_case != 3 && test_case != 200 {
5278                                 callback_msg(&mut update_add_1);
5279                         }
5280
5281                         // 1 => 2
5282                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5283                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5284
5285                         if test_case == 2 || test_case == 200 {
5286                                 expect_htlc_forward!(&nodes[2]);
5287                                 expect_event!(&nodes[2], Event::PaymentReceived);
5288                                 callback_node();
5289                                 expect_pending_htlcs_forwardable!(nodes[2]);
5290                         }
5291
5292                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5293                         if test_case == 2 || test_case == 200 {
5294                                 check_added_monitors!(&nodes[2], 1);
5295                         }
5296                         assert!(update_2_1.update_fail_htlcs.len() == 1);
5297
5298                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5299                         if test_case == 200 {
5300                                 callback_fail(&mut fail_msg);
5301                         }
5302
5303                         // 2 => 1
5304                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5305                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5306
5307                         // backward fail on 1
5308                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5309                         assert!(update_1_0.update_fail_htlcs.len() == 1);
5310                         update_1_0
5311                 },
5312                 _ => unreachable!(),
5313         };
5314
5315         // 1 => 0 commitment_signed_dance
5316         if update_1_0.update_fail_htlcs.len() > 0 {
5317                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5318                 if test_case == 100 {
5319                         callback_fail(&mut fail_msg);
5320                 }
5321                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5322         } else {
5323                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5324         };
5325
5326         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5327
5328         let events = nodes[0].node.get_and_clear_pending_events();
5329         assert_eq!(events.len(), 1);
5330         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
5331                 assert_eq!(*rejected_by_dest, !expected_retryable);
5332                 assert_eq!(*error_code, expected_error_code);
5333         } else {
5334                 panic!("Uexpected event");
5335         }
5336
5337         let events = nodes[0].node.get_and_clear_pending_msg_events();
5338         if expected_channel_update.is_some() {
5339                 assert_eq!(events.len(), 1);
5340                 match events[0] {
5341                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5342                                 match update {
5343                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5344                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5345                                                         panic!("channel_update not found!");
5346                                                 }
5347                                         },
5348                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5349                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5350                                                         assert!(*short_channel_id == *expected_short_channel_id);
5351                                                         assert!(*is_permanent == *expected_is_permanent);
5352                                                 } else {
5353                                                         panic!("Unexpected message event");
5354                                                 }
5355                                         },
5356                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5357                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5358                                                         assert!(*node_id == *expected_node_id);
5359                                                         assert!(*is_permanent == *expected_is_permanent);
5360                                                 } else {
5361                                                         panic!("Unexpected message event");
5362                                                 }
5363                                         },
5364                                 }
5365                         },
5366                         _ => panic!("Unexpected message event"),
5367                 }
5368         } else {
5369                 assert_eq!(events.len(), 0);
5370         }
5371 }
5372
5373 impl msgs::ChannelUpdate {
5374         fn dummy() -> msgs::ChannelUpdate {
5375                 use secp256k1::ffi::Signature as FFISignature;
5376                 use secp256k1::Signature;
5377                 msgs::ChannelUpdate {
5378                         signature: Signature::from(FFISignature::new()),
5379                         contents: msgs::UnsignedChannelUpdate {
5380                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5381                                 short_channel_id: 0,
5382                                 timestamp: 0,
5383                                 flags: 0,
5384                                 cltv_expiry_delta: 0,
5385                                 htlc_minimum_msat: 0,
5386                                 fee_base_msat: 0,
5387                                 fee_proportional_millionths: 0,
5388                                 excess_data: vec![],
5389                         }
5390                 }
5391         }
5392 }
5393
5394 struct BogusOnionHopData {
5395         data: Vec<u8>
5396 }
5397 impl BogusOnionHopData {
5398         fn new(orig: msgs::OnionHopData) -> Self {
5399                 Self { data: orig.encode() }
5400         }
5401 }
5402 impl Writeable for BogusOnionHopData {
5403         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5404                 writer.write_all(&self.data[..])
5405         }
5406 }
5407
5408 #[test]
5409 fn test_onion_failure() {
5410         use ln::msgs::ChannelUpdate;
5411         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5412         use secp256k1;
5413
5414         const BADONION: u16 = 0x8000;
5415         const PERM: u16 = 0x4000;
5416         const NODE: u16 = 0x2000;
5417         const UPDATE: u16 = 0x1000;
5418
5419         let chanmon_cfgs = create_chanmon_cfgs(3);
5420         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5421         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5422         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5423         for node in nodes.iter() {
5424                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5425         }
5426         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())];
5427         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5428         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5429         // positve case
5430         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5431
5432         // intermediate node failure
5433         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5434                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5435                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5436                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5437                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5438                 let mut new_payloads = Vec::new();
5439                 for payload in onion_payloads.drain(..) {
5440                         new_payloads.push(BogusOnionHopData::new(payload));
5441                 }
5442                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5443                 // describing a length-1 TLV payload, which is obviously bogus.
5444                 new_payloads[0].data[0] = 1;
5445                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5446         }, ||{}, 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
5447
5448         // final node failure
5449         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5450                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5451                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5452                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5453                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, cur_height).unwrap();
5454                 let mut new_payloads = Vec::new();
5455                 for payload in onion_payloads.drain(..) {
5456                         new_payloads.push(BogusOnionHopData::new(payload));
5457                 }
5458                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5459                 // length-1 TLV payload, which is obviously bogus.
5460                 new_payloads[1].data[0] = 1;
5461                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5462         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5463
5464         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5465         // receiving simulated fail messages
5466         // intermediate node failure
5467         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5468                 // trigger error
5469                 msg.amount_msat -= 1;
5470         }, |msg| {
5471                 // and tamper returning error message
5472                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5473                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5474                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5475         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: false}));
5476
5477         // final node failure
5478         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5479                 // and tamper returning error message
5480                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5481                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5482                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5483         }, ||{
5484                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5485         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: false}));
5486
5487         // intermediate node failure
5488         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5489                 msg.amount_msat -= 1;
5490         }, |msg| {
5491                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5492                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5493                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5494         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5495
5496         // final node failure
5497         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5498                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5499                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5500                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5501         }, ||{
5502                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5503         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5504
5505         // intermediate node failure
5506         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5507                 msg.amount_msat -= 1;
5508         }, |msg| {
5509                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5510                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5511                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5512         }, ||{
5513                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5514         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][0].pubkey, is_permanent: true}));
5515
5516         // final node failure
5517         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5518                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5519                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5520                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5521         }, ||{
5522                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5523         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.paths[0][1].pubkey, is_permanent: true}));
5524
5525         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5526                 Some(BADONION|PERM|4), None);
5527
5528         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5529                 Some(BADONION|PERM|5), None);
5530
5531         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5532                 Some(BADONION|PERM|6), None);
5533
5534         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5535                 msg.amount_msat -= 1;
5536         }, |msg| {
5537                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5538                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5539                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5540         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5541
5542         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5543                 msg.amount_msat -= 1;
5544         }, |msg| {
5545                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5546                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5547                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5548                 // short_channel_id from the processing node
5549         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5550
5551         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5552                 msg.amount_msat -= 1;
5553         }, |msg| {
5554                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5555                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5556                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5557                 // short_channel_id from the processing node
5558         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5559
5560         let mut bogus_route = route.clone();
5561         bogus_route.paths[0][1].short_channel_id -= 1;
5562         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5563           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.paths[0][1].short_channel_id, is_permanent:true}));
5564
5565         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5566         let mut bogus_route = route.clone();
5567         let route_len = bogus_route.paths[0].len();
5568         bogus_route.paths[0][route_len-1].fee_msat = amt_to_forward;
5569         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5570
5571         //TODO: with new config API, we will be able to generate both valid and
5572         //invalid channel_update cases.
5573         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5574                 msg.amount_msat -= 1;
5575         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5576
5577         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5578                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5579                 msg.cltv_expiry -= 1;
5580         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5581
5582         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5583                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5584                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5585
5586                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5587         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5588
5589         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5590                 nodes[2].node.fail_htlc_backwards(&payment_hash, &None);
5591         }, false, Some(PERM|15), None);
5592
5593         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5594                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5595                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5596
5597                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5598         }, || {}, true, Some(17), None);
5599
5600         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5601                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5602                         for f in pending_forwards.iter_mut() {
5603                                 match f {
5604                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5605                                                 forward_info.outgoing_cltv_value += 1,
5606                                         _ => {},
5607                                 }
5608                         }
5609                 }
5610         }, true, Some(18), None);
5611
5612         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5613                 // violate amt_to_forward > msg.amount_msat
5614                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5615                         for f in pending_forwards.iter_mut() {
5616                                 match f {
5617                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5618                                                 forward_info.amt_to_forward -= 1,
5619                                         _ => {},
5620                                 }
5621                         }
5622                 }
5623         }, true, Some(19), None);
5624
5625         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5626                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5627                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5628                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5629         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5630         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5631
5632         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5633                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5634                 let mut route = route.clone();
5635                 let height = 1;
5636                 route.paths[0][1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.paths[0][0].cltv_expiry_delta + 1;
5637                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route.paths[0], &session_priv).unwrap();
5638                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 40000, &None, height).unwrap();
5639                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5640                 msg.cltv_expiry = htlc_cltv;
5641                 msg.onion_routing_packet = onion_packet;
5642         }, ||{}, true, Some(21), None);
5643 }
5644
5645 #[test]
5646 #[should_panic]
5647 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5648         let chanmon_cfgs = create_chanmon_cfgs(2);
5649         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5650         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5651         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5652         //Force duplicate channel ids
5653         for node in nodes.iter() {
5654                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5655         }
5656
5657         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5658         let channel_value_satoshis=10000;
5659         let push_msat=10001;
5660         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5661         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5662         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5663
5664         //Create a second channel with a channel_id collision
5665         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5666 }
5667
5668 #[test]
5669 fn bolt2_open_channel_sending_node_checks_part2() {
5670         let chanmon_cfgs = create_chanmon_cfgs(2);
5671         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5672         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5673         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5674
5675         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5676         let channel_value_satoshis=2^24;
5677         let push_msat=10001;
5678         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5679
5680         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5681         let channel_value_satoshis=10000;
5682         // Test when push_msat is equal to 1000 * funding_satoshis.
5683         let push_msat=1000*channel_value_satoshis+1;
5684         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5685
5686         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5687         let channel_value_satoshis=10000;
5688         let push_msat=10001;
5689         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
5690         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5691         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5692
5693         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5694         // 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
5695         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5696
5697         // 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.
5698         assert!(BREAKDOWN_TIMEOUT>0);
5699         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5700
5701         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5702         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5703         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5704
5705         // 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.
5706         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5707         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5708         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5709         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5710         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5711 }
5712
5713 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5714 // 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.
5715 //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.
5716
5717 #[test]
5718 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5719         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5720         let chanmon_cfgs = create_chanmon_cfgs(2);
5721         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5722         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5723         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5724         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5725         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5726         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5727
5728         route.paths[0][0].fee_msat = 100;
5729
5730         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5731                 assert_eq!(err, "Cannot send less than their minimum HTLC value"));
5732         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5733         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5734 }
5735
5736 #[test]
5737 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
5738         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5739         let chanmon_cfgs = create_chanmon_cfgs(2);
5740         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5741         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5742         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5743         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5744         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5745         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5746
5747         route.paths[0][0].fee_msat = 0;
5748
5749         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5750                 assert_eq!(err, "Cannot send 0-msat HTLC"));
5751         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5752         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
5753 }
5754
5755 #[test]
5756 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
5757         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5758         let chanmon_cfgs = create_chanmon_cfgs(2);
5759         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5760         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5761         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5762         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5763         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5764         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5765
5766         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5767         check_added_monitors!(nodes[0], 1);
5768         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5769         updates.update_add_htlcs[0].amount_msat = 0;
5770
5771         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5772         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
5773         check_closed_broadcast!(nodes[1], true).unwrap();
5774         check_added_monitors!(nodes[1], 1);
5775 }
5776
5777 #[test]
5778 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5779         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5780         //It is enforced when constructing a route.
5781         let chanmon_cfgs = create_chanmon_cfgs(2);
5782         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5783         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5784         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5785         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5786         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5787         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5788
5789         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::RouteError { err },
5790                 assert_eq!(err, "Channel CLTV overflowed?!"));
5791 }
5792
5793 #[test]
5794 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5795         //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.
5796         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5797         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5798         let chanmon_cfgs = create_chanmon_cfgs(2);
5799         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5800         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5801         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5802         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5803         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5804
5805         for i in 0..max_accepted_htlcs {
5806                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5807                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5808                 let payment_event = {
5809                         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5810                         check_added_monitors!(nodes[0], 1);
5811
5812                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5813                         assert_eq!(events.len(), 1);
5814                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5815                                 assert_eq!(htlcs[0].htlc_id, i);
5816                         } else {
5817                                 assert!(false);
5818                         }
5819                         SendEvent::from_event(events.remove(0))
5820                 };
5821                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5822                 check_added_monitors!(nodes[1], 0);
5823                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5824
5825                 expect_pending_htlcs_forwardable!(nodes[1]);
5826                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5827         }
5828         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5829         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5830         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5831                 assert_eq!(err, "Cannot push more than their max accepted HTLCs"));
5832
5833         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5834         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
5835 }
5836
5837 #[test]
5838 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5839         //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.
5840         let chanmon_cfgs = create_chanmon_cfgs(2);
5841         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5842         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5843         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5844         let channel_value = 100000;
5845         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5846         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5847
5848         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5849
5850         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5851         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5852         unwrap_send_err!(nodes[0].node.send_payment(&route, our_payment_hash, &None), true, APIError::ChannelUnavailable { err },
5853                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"));
5854
5855         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5856         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);
5857
5858         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5859 }
5860
5861 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5862 #[test]
5863 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5864         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5865         let chanmon_cfgs = create_chanmon_cfgs(2);
5866         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5867         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5868         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5869         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5870         let htlc_minimum_msat: u64;
5871         {
5872                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5873                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5874                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5875         }
5876         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5877         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5878         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5879         check_added_monitors!(nodes[0], 1);
5880         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5881         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5882         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5883         assert!(nodes[1].node.list_channels().is_empty());
5884         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5885         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5886         check_added_monitors!(nodes[1], 1);
5887 }
5888
5889 #[test]
5890 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5891         //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
5892         let chanmon_cfgs = create_chanmon_cfgs(2);
5893         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5894         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5895         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5896         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5897
5898         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5899
5900         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, 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
5906         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5907         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5908
5909         assert!(nodes[1].node.list_channels().is_empty());
5910         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5911         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5912         check_added_monitors!(nodes[1], 1);
5913 }
5914
5915 #[test]
5916 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5917         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5918         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5919         let chanmon_cfgs = create_chanmon_cfgs(2);
5920         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5921         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5922         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5923         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5924         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5925         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5926
5927         let session_priv = SecretKey::from_slice(&{
5928                 let mut session_key = [0; 32];
5929                 let mut rng = thread_rng();
5930                 rng.fill_bytes(&mut session_key);
5931                 session_key
5932         }).expect("RNG is bad!");
5933
5934         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5935         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route.paths[0], &session_priv).unwrap();
5936         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route.paths[0], 3999999, &None, cur_height).unwrap();
5937         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5938
5939         let mut msg = msgs::UpdateAddHTLC {
5940                 channel_id: chan.2,
5941                 htlc_id: 0,
5942                 amount_msat: 1000,
5943                 payment_hash: our_payment_hash,
5944                 cltv_expiry: htlc_cltv,
5945                 onion_routing_packet: onion_packet.clone(),
5946         };
5947
5948         for i in 0..super::channel::OUR_MAX_HTLCS {
5949                 msg.htlc_id = i as u64;
5950                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5951         }
5952         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5953         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5954
5955         assert!(nodes[1].node.list_channels().is_empty());
5956         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5957         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5958         check_added_monitors!(nodes[1], 1);
5959 }
5960
5961 #[test]
5962 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5963         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5964         let chanmon_cfgs = create_chanmon_cfgs(2);
5965         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5966         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5967         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5968         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5969         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5970         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5971         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5972         check_added_monitors!(nodes[0], 1);
5973         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5974         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5975         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5976
5977         assert!(nodes[1].node.list_channels().is_empty());
5978         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5979         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
5980         check_added_monitors!(nodes[1], 1);
5981 }
5982
5983 #[test]
5984 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5985         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5986         let chanmon_cfgs = create_chanmon_cfgs(2);
5987         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5988         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5989         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5990         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5991         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5992         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5993         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
5994         check_added_monitors!(nodes[0], 1);
5995         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5996         updates.update_add_htlcs[0].cltv_expiry = 500000000;
5997         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5998
5999         assert!(nodes[1].node.list_channels().is_empty());
6000         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6001         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6002         check_added_monitors!(nodes[1], 1);
6003 }
6004
6005 #[test]
6006 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6007         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6008         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6009         // after disconnect and that non-sequential htlc_ids result in a channel failure.
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(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6015         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, 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 updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6020         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6021
6022         //Disconnect and Reconnect
6023         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6024         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6025         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6026         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6027         assert_eq!(reestablish_1.len(), 1);
6028         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6029         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6030         assert_eq!(reestablish_2.len(), 1);
6031         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6032         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6033         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6034         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6035
6036         //Resend HTLC
6037         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6038         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6039         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6040         check_added_monitors!(nodes[1], 1);
6041         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6042
6043         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6044
6045         assert!(nodes[1].node.list_channels().is_empty());
6046         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6047         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
6048         check_added_monitors!(nodes[1], 1);
6049 }
6050
6051 #[test]
6052 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6053         //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.
6054
6055         let chanmon_cfgs = create_chanmon_cfgs(2);
6056         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6057         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6058         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6059         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6060
6061         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6062         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6063         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6064         check_added_monitors!(nodes[0], 1);
6065         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6066         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6067
6068         let update_msg = msgs::UpdateFulfillHTLC{
6069                 channel_id: chan.2,
6070                 htlc_id: 0,
6071                 payment_preimage: our_payment_preimage,
6072         };
6073
6074         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6075
6076         assert!(nodes[0].node.list_channels().is_empty());
6077         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6078         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6079         check_added_monitors!(nodes[0], 1);
6080 }
6081
6082 #[test]
6083 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6084         //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.
6085
6086         let chanmon_cfgs = create_chanmon_cfgs(2);
6087         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6088         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6089         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6090         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6091
6092         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6093         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6094         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6095         check_added_monitors!(nodes[0], 1);
6096         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6097         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6098
6099         let update_msg = msgs::UpdateFailHTLC{
6100                 channel_id: chan.2,
6101                 htlc_id: 0,
6102                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6103         };
6104
6105         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6106
6107         assert!(nodes[0].node.list_channels().is_empty());
6108         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6109         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6110         check_added_monitors!(nodes[0], 1);
6111 }
6112
6113 #[test]
6114 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6115         //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.
6116
6117         let chanmon_cfgs = create_chanmon_cfgs(2);
6118         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6119         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6120         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6121         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6122
6123         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6124         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6125         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6126         check_added_monitors!(nodes[0], 1);
6127         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6128         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6129
6130         let update_msg = msgs::UpdateFailMalformedHTLC{
6131                 channel_id: chan.2,
6132                 htlc_id: 0,
6133                 sha256_of_onion: [1; 32],
6134                 failure_code: 0x8000,
6135         };
6136
6137         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6138
6139         assert!(nodes[0].node.list_channels().is_empty());
6140         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6141         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6142         check_added_monitors!(nodes[0], 1);
6143 }
6144
6145 #[test]
6146 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6147         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6148
6149         let chanmon_cfgs = create_chanmon_cfgs(2);
6150         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6151         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6152         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6153         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6154
6155         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6156
6157         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6158         check_added_monitors!(nodes[1], 1);
6159
6160         let events = nodes[1].node.get_and_clear_pending_msg_events();
6161         assert_eq!(events.len(), 1);
6162         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6163                 match events[0] {
6164                         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, .. } } => {
6165                                 assert!(update_add_htlcs.is_empty());
6166                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6167                                 assert!(update_fail_htlcs.is_empty());
6168                                 assert!(update_fail_malformed_htlcs.is_empty());
6169                                 assert!(update_fee.is_none());
6170                                 update_fulfill_htlcs[0].clone()
6171                         },
6172                         _ => panic!("Unexpected event"),
6173                 }
6174         };
6175
6176         update_fulfill_msg.htlc_id = 1;
6177
6178         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6179
6180         assert!(nodes[0].node.list_channels().is_empty());
6181         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6182         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6183         check_added_monitors!(nodes[0], 1);
6184 }
6185
6186 #[test]
6187 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6188         //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.
6189
6190         let chanmon_cfgs = create_chanmon_cfgs(2);
6191         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6192         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6193         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6194         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6195
6196         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6197
6198         nodes[1].node.claim_funds(our_payment_preimage, &None, 100_000);
6199         check_added_monitors!(nodes[1], 1);
6200
6201         let events = nodes[1].node.get_and_clear_pending_msg_events();
6202         assert_eq!(events.len(), 1);
6203         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6204                 match events[0] {
6205                         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, .. } } => {
6206                                 assert!(update_add_htlcs.is_empty());
6207                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6208                                 assert!(update_fail_htlcs.is_empty());
6209                                 assert!(update_fail_malformed_htlcs.is_empty());
6210                                 assert!(update_fee.is_none());
6211                                 update_fulfill_htlcs[0].clone()
6212                         },
6213                         _ => panic!("Unexpected event"),
6214                 }
6215         };
6216
6217         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6218
6219         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6220
6221         assert!(nodes[0].node.list_channels().is_empty());
6222         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6223         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
6224         check_added_monitors!(nodes[0], 1);
6225 }
6226
6227 #[test]
6228 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6229         //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.
6230
6231         let chanmon_cfgs = create_chanmon_cfgs(2);
6232         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6233         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6234         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6235         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6236         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6237         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6238         nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6239         check_added_monitors!(nodes[0], 1);
6240
6241         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6242         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6243
6244         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6245         check_added_monitors!(nodes[1], 0);
6246         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6247
6248         let events = nodes[1].node.get_and_clear_pending_msg_events();
6249
6250         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6251                 match events[0] {
6252                         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, .. } } => {
6253                                 assert!(update_add_htlcs.is_empty());
6254                                 assert!(update_fulfill_htlcs.is_empty());
6255                                 assert!(update_fail_htlcs.is_empty());
6256                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6257                                 assert!(update_fee.is_none());
6258                                 update_fail_malformed_htlcs[0].clone()
6259                         },
6260                         _ => panic!("Unexpected event"),
6261                 }
6262         };
6263         update_msg.failure_code &= !0x8000;
6264         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6265
6266         assert!(nodes[0].node.list_channels().is_empty());
6267         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6268         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6269         check_added_monitors!(nodes[0], 1);
6270 }
6271
6272 #[test]
6273 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6274         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6275         //    * 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.
6276
6277         let chanmon_cfgs = create_chanmon_cfgs(3);
6278         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6279         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6280         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6281         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6282         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6283
6284         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
6285         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6286
6287         //First hop
6288         let mut payment_event = {
6289                 nodes[0].node.send_payment(&route, our_payment_hash, &None).unwrap();
6290                 check_added_monitors!(nodes[0], 1);
6291                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6292                 assert_eq!(events.len(), 1);
6293                 SendEvent::from_event(events.remove(0))
6294         };
6295         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6296         check_added_monitors!(nodes[1], 0);
6297         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6298         expect_pending_htlcs_forwardable!(nodes[1]);
6299         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6300         assert_eq!(events_2.len(), 1);
6301         check_added_monitors!(nodes[1], 1);
6302         payment_event = SendEvent::from_event(events_2.remove(0));
6303         assert_eq!(payment_event.msgs.len(), 1);
6304
6305         //Second Hop
6306         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6307         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6308         check_added_monitors!(nodes[2], 0);
6309         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6310
6311         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6312         assert_eq!(events_3.len(), 1);
6313         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6314                 match events_3[0] {
6315                         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 } } => {
6316                                 assert!(update_add_htlcs.is_empty());
6317                                 assert!(update_fulfill_htlcs.is_empty());
6318                                 assert!(update_fail_htlcs.is_empty());
6319                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6320                                 assert!(update_fee.is_none());
6321                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6322                         },
6323                         _ => panic!("Unexpected event"),
6324                 }
6325         };
6326
6327         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6328
6329         check_added_monitors!(nodes[1], 0);
6330         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6331         expect_pending_htlcs_forwardable!(nodes[1]);
6332         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6333         assert_eq!(events_4.len(), 1);
6334
6335         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6336         match events_4[0] {
6337                 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, .. } } => {
6338                         assert!(update_add_htlcs.is_empty());
6339                         assert!(update_fulfill_htlcs.is_empty());
6340                         assert_eq!(update_fail_htlcs.len(), 1);
6341                         assert!(update_fail_malformed_htlcs.is_empty());
6342                         assert!(update_fee.is_none());
6343                 },
6344                 _ => panic!("Unexpected event"),
6345         };
6346
6347         check_added_monitors!(nodes[1], 1);
6348 }
6349
6350 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6351         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6352         // 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
6353         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6354
6355         let chanmon_cfgs = create_chanmon_cfgs(2);
6356         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6357         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6358         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6359         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6360
6361         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6362
6363         // We route 2 dust-HTLCs between A and B
6364         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6365         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6366         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6367
6368         // Cache one local commitment tx as previous
6369         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6370
6371         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6372         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2, &None));
6373         check_added_monitors!(nodes[1], 0);
6374         expect_pending_htlcs_forwardable!(nodes[1]);
6375         check_added_monitors!(nodes[1], 1);
6376
6377         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6378         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6379         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6380         check_added_monitors!(nodes[0], 1);
6381
6382         // Cache one local commitment tx as lastest
6383         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6384
6385         let events = nodes[0].node.get_and_clear_pending_msg_events();
6386         match events[0] {
6387                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6388                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6389                 },
6390                 _ => panic!("Unexpected event"),
6391         }
6392         match events[1] {
6393                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6394                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6395                 },
6396                 _ => panic!("Unexpected event"),
6397         }
6398
6399         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6400         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6401         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6402
6403         if announce_latest {
6404                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6405         } else {
6406                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6407         }
6408
6409         check_closed_broadcast!(nodes[0], false);
6410         check_added_monitors!(nodes[0], 1);
6411
6412         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6413         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
6414         let events = nodes[0].node.get_and_clear_pending_events();
6415         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6416         assert_eq!(events.len(), 2);
6417         let mut first_failed = false;
6418         for event in events {
6419                 match event {
6420                         Event::PaymentFailed { payment_hash, .. } => {
6421                                 if payment_hash == payment_hash_1 {
6422                                         assert!(!first_failed);
6423                                         first_failed = true;
6424                                 } else {
6425                                         assert_eq!(payment_hash, payment_hash_2);
6426                                 }
6427                         }
6428                         _ => panic!("Unexpected event"),
6429                 }
6430         }
6431 }
6432
6433 #[test]
6434 fn test_failure_delay_dust_htlc_local_commitment() {
6435         do_test_failure_delay_dust_htlc_local_commitment(true);
6436         do_test_failure_delay_dust_htlc_local_commitment(false);
6437 }
6438
6439 #[test]
6440 fn test_no_failure_dust_htlc_local_commitment() {
6441         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6442         // prone to error, we test here that a dummy transaction don't fail them.
6443
6444         let chanmon_cfgs = create_chanmon_cfgs(2);
6445         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6446         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6447         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6448         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6449
6450         // Rebalance a bit
6451         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6452
6453         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6454         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6455
6456         // We route 2 dust-HTLCs between A and B
6457         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6458         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6459
6460         // Build a dummy invalid transaction trying to spend a commitment tx
6461         let input = TxIn {
6462                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6463                 script_sig: Script::new(),
6464                 sequence: 0,
6465                 witness: Vec::new(),
6466         };
6467
6468         let outp = TxOut {
6469                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6470                 value: 10000,
6471         };
6472
6473         let dummy_tx = Transaction {
6474                 version: 2,
6475                 lock_time: 0,
6476                 input: vec![input],
6477                 output: vec![outp]
6478         };
6479
6480         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6481         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6482         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6483         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6484         // We broadcast a few more block to check everything is all right
6485         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
6486         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6487         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6488
6489         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6490         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6491 }
6492
6493 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6494         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6495         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6496         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6497         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6498         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6499         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6500
6501         let chanmon_cfgs = create_chanmon_cfgs(3);
6502         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6503         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6504         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6505         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6506
6507         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6508
6509         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6510         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6511
6512         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6513         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
6514
6515         // We revoked bs_commitment_tx
6516         if revoked {
6517                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6518                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6519         }
6520
6521         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6522         let mut timeout_tx = Vec::new();
6523         if local {
6524                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6525                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6526                 check_closed_broadcast!(nodes[0], false);
6527                 check_added_monitors!(nodes[0], 1);
6528                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6529                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6530                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6531                 let events = nodes[0].node.get_and_clear_pending_events();
6532                 assert_eq!(events.len(), 1);
6533                 match events[0] {
6534                         Event::PaymentFailed { payment_hash, .. } => {
6535                                 assert_eq!(payment_hash, dust_hash);
6536                         },
6537                         _ => panic!("Unexpected event"),
6538                 }
6539                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6540                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6541                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6542                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6543                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6544                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6545                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6546                 let events = nodes[0].node.get_and_clear_pending_events();
6547                 assert_eq!(events.len(), 1);
6548                 match events[0] {
6549                         Event::PaymentFailed { payment_hash, .. } => {
6550                                 assert_eq!(payment_hash, non_dust_hash);
6551                         },
6552                         _ => panic!("Unexpected event"),
6553                 }
6554         } else {
6555                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6556                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6557                 check_closed_broadcast!(nodes[0], false);
6558                 check_added_monitors!(nodes[0], 1);
6559                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6560                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6561                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6562                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6563                 if !revoked {
6564                         let events = nodes[0].node.get_and_clear_pending_events();
6565                         assert_eq!(events.len(), 1);
6566                         match events[0] {
6567                                 Event::PaymentFailed { payment_hash, .. } => {
6568                                         assert_eq!(payment_hash, dust_hash);
6569                                 },
6570                                 _ => panic!("Unexpected event"),
6571                         }
6572                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6573                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6574                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6575                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6576                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6577                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6578                         let events = nodes[0].node.get_and_clear_pending_events();
6579                         assert_eq!(events.len(), 1);
6580                         match events[0] {
6581                                 Event::PaymentFailed { payment_hash, .. } => {
6582                                         assert_eq!(payment_hash, non_dust_hash);
6583                                 },
6584                                 _ => panic!("Unexpected event"),
6585                         }
6586                 } else {
6587                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6588                         // commitment tx
6589                         let events = nodes[0].node.get_and_clear_pending_events();
6590                         assert_eq!(events.len(), 2);
6591                         let first;
6592                         match events[0] {
6593                                 Event::PaymentFailed { payment_hash, .. } => {
6594                                         if payment_hash == dust_hash { first = true; }
6595                                         else { first = false; }
6596                                 },
6597                                 _ => panic!("Unexpected event"),
6598                         }
6599                         match events[1] {
6600                                 Event::PaymentFailed { payment_hash, .. } => {
6601                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6602                                         else { assert_eq!(payment_hash, dust_hash); }
6603                                 },
6604                                 _ => panic!("Unexpected event"),
6605                         }
6606                 }
6607         }
6608 }
6609
6610 #[test]
6611 fn test_sweep_outbound_htlc_failure_update() {
6612         do_test_sweep_outbound_htlc_failure_update(false, true);
6613         do_test_sweep_outbound_htlc_failure_update(false, false);
6614         do_test_sweep_outbound_htlc_failure_update(true, false);
6615 }
6616
6617 #[test]
6618 fn test_upfront_shutdown_script() {
6619         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6620         // enforce it at shutdown message
6621
6622         let mut config = UserConfig::default();
6623         config.channel_options.announced_channel = true;
6624         config.peer_channel_config_limits.force_announced_channel_preference = false;
6625         config.channel_options.commit_upfront_shutdown_pubkey = false;
6626         let user_cfgs = [None, Some(config), None];
6627         let chanmon_cfgs = create_chanmon_cfgs(3);
6628         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6629         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6630         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6631
6632         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6633         let flags = InitFeatures::supported();
6634         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6635         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6636         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6637         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6638         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6639         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6640         assert_eq!(check_closed_broadcast!(nodes[2], true).unwrap().data, "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6641         check_added_monitors!(nodes[2], 1);
6642
6643         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6644         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6645         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6646         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6647         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6648         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6649         let events = nodes[2].node.get_and_clear_pending_msg_events();
6650         assert_eq!(events.len(), 1);
6651         match events[0] {
6652                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6653                 _ => panic!("Unexpected event"),
6654         }
6655
6656         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6657         let mut flags_no = InitFeatures::supported();
6658         flags_no.unset_upfront_shutdown_script();
6659         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6660         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6661         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6662         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6663         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6664         let events = nodes[1].node.get_and_clear_pending_msg_events();
6665         assert_eq!(events.len(), 1);
6666         match events[0] {
6667                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6668                 _ => panic!("Unexpected event"),
6669         }
6670
6671         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6672         // channel smoothly, opt-out is from channel initiator here
6673         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6674         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6675         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6676         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6677         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6678         let events = nodes[0].node.get_and_clear_pending_msg_events();
6679         assert_eq!(events.len(), 1);
6680         match events[0] {
6681                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6682                 _ => panic!("Unexpected event"),
6683         }
6684
6685         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6686         //// channel smoothly
6687         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6688         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6689         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6690         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6691         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6692         let events = nodes[0].node.get_and_clear_pending_msg_events();
6693         assert_eq!(events.len(), 2);
6694         match events[0] {
6695                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6696                 _ => panic!("Unexpected event"),
6697         }
6698         match events[1] {
6699                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6700                 _ => panic!("Unexpected event"),
6701         }
6702 }
6703
6704 #[test]
6705 fn test_user_configurable_csv_delay() {
6706         // We test our channel constructors yield errors when we pass them absurd csv delay
6707
6708         let mut low_our_to_self_config = UserConfig::default();
6709         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6710         let mut high_their_to_self_config = UserConfig::default();
6711         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6712         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6713         let chanmon_cfgs = create_chanmon_cfgs(2);
6714         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6715         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6716         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6717
6718         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6719         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())));
6720         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) {
6721                 match error {
6722                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6723                         _ => panic!("Unexpected event"),
6724                 }
6725         } else { assert!(false) }
6726
6727         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6728         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6729         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6730         open_channel.to_self_delay = 200;
6731         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) {
6732                 match error {
6733                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6734                         _ => panic!("Unexpected event"),
6735                 }
6736         } else { assert!(false); }
6737
6738         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6739         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6740         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()));
6741         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6742         accept_channel.to_self_delay = 200;
6743         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6744         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6745                 match action {
6746                         &ErrorAction::SendErrorMessage { ref msg } => {
6747                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6748                         },
6749                         _ => { assert!(false); }
6750                 }
6751         } else { assert!(false); }
6752
6753         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6754         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6755         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6756         open_channel.to_self_delay = 200;
6757         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) {
6758                 match error {
6759                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6760                         _ => panic!("Unexpected event"),
6761                 }
6762         } else { assert!(false); }
6763 }
6764
6765 #[test]
6766 fn test_data_loss_protect() {
6767         // We want to be sure that :
6768         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6769         // * we close channel in case of detecting other being fallen behind
6770         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6771         let keys_manager;
6772         let fee_estimator;
6773         let tx_broadcaster;
6774         let monitor;
6775         let node_state_0;
6776         let chanmon_cfgs = create_chanmon_cfgs(2);
6777         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6778         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6779         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6780
6781         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6782
6783         // Cache node A state before any channel update
6784         let previous_node_state = nodes[0].node.encode();
6785         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6786         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6787
6788         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6789         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6790
6791         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6792         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6793
6794         // Restore node A from previous state
6795         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6796         let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6797         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6798         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new()), broadcasted_txn: Mutex::new(HashMap::new())};
6799         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
6800         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger));
6801         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &tx_broadcaster, logger.clone(), &fee_estimator);
6802         node_state_0 = {
6803                 let mut channel_monitors = HashMap::new();
6804                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6805                 <(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 {
6806                         keys_manager: &keys_manager,
6807                         fee_estimator: &fee_estimator,
6808                         monitor: &monitor,
6809                         logger: Arc::clone(&logger),
6810                         tx_broadcaster: &tx_broadcaster,
6811                         default_config: UserConfig::default(),
6812                         channel_monitors: &mut channel_monitors,
6813                 }).unwrap().1
6814         };
6815         nodes[0].node = &node_state_0;
6816         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
6817         nodes[0].chan_monitor = &monitor;
6818         nodes[0].chain_monitor = chain_monitor;
6819
6820         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6821         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6822         nodes[0].block_notifier.register_listener(nodes[0].node);
6823
6824         check_added_monitors!(nodes[0], 1);
6825
6826         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6827         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6828
6829         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6830
6831         // Check we update monitor following learning of per_commitment_point from B
6832         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6833         check_added_monitors!(nodes[0], 2);
6834
6835         {
6836                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6837                 assert_eq!(node_txn.len(), 0);
6838         }
6839
6840         let mut reestablish_1 = Vec::with_capacity(1);
6841         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6842                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6843                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6844                         reestablish_1.push(msg.clone());
6845                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6846                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6847                         match action {
6848                                 &ErrorAction::SendErrorMessage { ref msg } => {
6849                                         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");
6850                                 },
6851                                 _ => panic!("Unexpected event!"),
6852                         }
6853                 } else {
6854                         panic!("Unexpected event")
6855                 }
6856         }
6857
6858         // Check we close channel detecting A is fallen-behind
6859         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6860         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
6861         check_added_monitors!(nodes[1], 1);
6862
6863
6864         // Check A is able to claim to_remote output
6865         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6866         assert_eq!(node_txn.len(), 1);
6867         check_spends!(node_txn[0], chan.3);
6868         assert_eq!(node_txn[0].output.len(), 2);
6869         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6870         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
6871         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
6872         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6873         assert_eq!(spend_txn.len(), 1);
6874         check_spends!(spend_txn[0], node_txn[0]);
6875 }
6876
6877 #[test]
6878 fn test_check_htlc_underpaying() {
6879         // Send payment through A -> B but A is maliciously
6880         // sending a probe payment (i.e less than expected value0
6881         // to B, B should refuse payment.
6882
6883         let chanmon_cfgs = create_chanmon_cfgs(2);
6884         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6885         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6886         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6887
6888         // Create some initial channels
6889         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6890
6891         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6892
6893         // Node 3 is expecting payment of 100_000 but receive 10_000,
6894         // fail htlc like we didn't know the preimage.
6895         nodes[1].node.claim_funds(payment_preimage, &None, 100_000);
6896         nodes[1].node.process_pending_htlc_forwards();
6897
6898         let events = nodes[1].node.get_and_clear_pending_msg_events();
6899         assert_eq!(events.len(), 1);
6900         let (update_fail_htlc, commitment_signed) = match events[0] {
6901                 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 } } => {
6902                         assert!(update_add_htlcs.is_empty());
6903                         assert!(update_fulfill_htlcs.is_empty());
6904                         assert_eq!(update_fail_htlcs.len(), 1);
6905                         assert!(update_fail_malformed_htlcs.is_empty());
6906                         assert!(update_fee.is_none());
6907                         (update_fail_htlcs[0].clone(), commitment_signed)
6908                 },
6909                 _ => panic!("Unexpected event"),
6910         };
6911         check_added_monitors!(nodes[1], 1);
6912
6913         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6914         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6915
6916         let events = nodes[0].node.get_and_clear_pending_events();
6917         assert_eq!(events.len(), 1);
6918         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6919                 assert_eq!(*rejected_by_dest, true);
6920                 assert_eq!(error_code.unwrap(), 0x4000|15);
6921         } else {
6922                 panic!("Unexpected event");
6923         }
6924         nodes[1].node.get_and_clear_pending_events();
6925 }
6926
6927 #[test]
6928 fn test_announce_disable_channels() {
6929         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6930         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6931
6932         let chanmon_cfgs = create_chanmon_cfgs(2);
6933         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6934         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6935         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6936
6937         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6938         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6939         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6940
6941         // Disconnect peers
6942         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6943         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6944
6945         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6946         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6947         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6948         assert_eq!(msg_events.len(), 3);
6949         for e in msg_events {
6950                 match e {
6951                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6952                                 let short_id = msg.contents.short_channel_id;
6953                                 // Check generated channel_update match list in PendingChannelUpdate
6954                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6955                                         panic!("Generated ChannelUpdate for wrong chan!");
6956                                 }
6957                         },
6958                         _ => panic!("Unexpected event"),
6959                 }
6960         }
6961         // Reconnect peers
6962         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6963         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6964         assert_eq!(reestablish_1.len(), 3);
6965         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6966         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6967         assert_eq!(reestablish_2.len(), 3);
6968
6969         // Reestablish chan_1
6970         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6971         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6972         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6973         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6974         // Reestablish chan_2
6975         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
6976         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6977         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
6978         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6979         // Reestablish chan_3
6980         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
6981         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6982         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
6983         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6984
6985         nodes[0].node.timer_chan_freshness_every_min();
6986         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6987 }
6988
6989 #[test]
6990 fn test_bump_penalty_txn_on_revoked_commitment() {
6991         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
6992         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
6993
6994         let chanmon_cfgs = create_chanmon_cfgs(2);
6995         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6996         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6997         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6998
6999         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7000         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7001         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
7002         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7003
7004         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7005         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7006         assert_eq!(revoked_txn[0].output.len(), 4);
7007         assert_eq!(revoked_txn[0].input.len(), 1);
7008         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7009         let revoked_txid = revoked_txn[0].txid();
7010
7011         let mut penalty_sum = 0;
7012         for outp in revoked_txn[0].output.iter() {
7013                 if outp.script_pubkey.is_v0_p2wsh() {
7014                         penalty_sum += outp.value;
7015                 }
7016         }
7017
7018         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7019         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
7020
7021         // Actually revoke tx by claiming a HTLC
7022         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7023         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7024         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7025         check_added_monitors!(nodes[1], 1);
7026
7027         // One or more justice tx should have been broadcast, check it
7028         let penalty_1;
7029         let feerate_1;
7030         {
7031                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7032                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7033                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7034                 assert_eq!(node_txn[0].output.len(), 1);
7035                 check_spends!(node_txn[0], revoked_txn[0]);
7036                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7037                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7038                 penalty_1 = node_txn[0].txid();
7039                 node_txn.clear();
7040         };
7041
7042         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7043         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
7044         let mut penalty_2 = penalty_1;
7045         let mut feerate_2 = 0;
7046         {
7047                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7048                 assert_eq!(node_txn.len(), 1);
7049                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7050                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7051                         assert_eq!(node_txn[0].output.len(), 1);
7052                         check_spends!(node_txn[0], revoked_txn[0]);
7053                         penalty_2 = node_txn[0].txid();
7054                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7055                         assert_ne!(penalty_2, penalty_1);
7056                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7057                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7058                         // Verify 25% bump heuristic
7059                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7060                         node_txn.clear();
7061                 }
7062         }
7063         assert_ne!(feerate_2, 0);
7064
7065         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7066         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
7067         let penalty_3;
7068         let mut feerate_3 = 0;
7069         {
7070                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7071                 assert_eq!(node_txn.len(), 1);
7072                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7073                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7074                         assert_eq!(node_txn[0].output.len(), 1);
7075                         check_spends!(node_txn[0], revoked_txn[0]);
7076                         penalty_3 = node_txn[0].txid();
7077                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7078                         assert_ne!(penalty_3, penalty_2);
7079                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7080                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7081                         // Verify 25% bump heuristic
7082                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7083                         node_txn.clear();
7084                 }
7085         }
7086         assert_ne!(feerate_3, 0);
7087
7088         nodes[1].node.get_and_clear_pending_events();
7089         nodes[1].node.get_and_clear_pending_msg_events();
7090 }
7091
7092 #[test]
7093 fn test_bump_penalty_txn_on_revoked_htlcs() {
7094         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7095         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7096
7097         let chanmon_cfgs = create_chanmon_cfgs(2);
7098         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7099         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7100         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7101
7102         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7103         // Lock HTLC in both directions
7104         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7105         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7106
7107         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7108         assert_eq!(revoked_local_txn[0].input.len(), 1);
7109         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7110
7111         // Revoke local commitment tx
7112         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7113
7114         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7115         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7116         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7117         check_closed_broadcast!(nodes[1], false);
7118         check_added_monitors!(nodes[1], 1);
7119
7120         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7121         assert_eq!(revoked_htlc_txn.len(), 6);
7122         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7123                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7124                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7125                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7126                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7127                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7128         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7129                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7130                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7131                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7132                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7133                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7134         }
7135
7136         // Broadcast set of revoked txn on A
7137         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
7138         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7139         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);
7140         let first;
7141         let feerate_1;
7142         let penalty_txn;
7143         {
7144                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7145                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7146                 // Verify claim tx are spending revoked HTLC txn
7147                 assert_eq!(node_txn[4].input.len(), 2);
7148                 assert_eq!(node_txn[4].output.len(), 1);
7149                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7150                 first = node_txn[4].txid();
7151                 // Store both feerates for later comparison
7152                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7153                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7154                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7155                 node_txn.clear();
7156         }
7157
7158         // Connect three more block to see if bumped penalty are issued for HTLC txn
7159         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7160         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7161         {
7162                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7163                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7164
7165                 check_spends!(node_txn[0], revoked_local_txn[0]);
7166                 check_spends!(node_txn[1], revoked_local_txn[0]);
7167
7168                 node_txn.clear();
7169         };
7170
7171         // Few more blocks to confirm penalty txn
7172         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
7173         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7174         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
7175         let node_txn = {
7176                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7177                 assert_eq!(node_txn.len(), 1);
7178
7179                 assert_eq!(node_txn[0].input.len(), 2);
7180                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7181                 // Verify bumped tx is different and 25% bump heuristic
7182                 assert_ne!(first, node_txn[0].txid());
7183                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7184                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7185                 assert!(feerate_2 * 100 > feerate_1 * 125);
7186                 let txn = vec![node_txn[0].clone()];
7187                 node_txn.clear();
7188                 txn
7189         };
7190         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7191         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7192         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
7193         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
7194         {
7195                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7196                 // We verify than no new transaction has been broadcast because previously
7197                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7198                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7199                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7200                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7201                 // up bumped justice generation.
7202                 assert_eq!(node_txn.len(), 0);
7203                 node_txn.clear();
7204         }
7205         check_closed_broadcast!(nodes[0], false);
7206         check_added_monitors!(nodes[0], 1);
7207 }
7208
7209 #[test]
7210 fn test_bump_penalty_txn_on_remote_commitment() {
7211         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7212         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7213
7214         // Create 2 HTLCs
7215         // Provide preimage for one
7216         // Check aggregation
7217
7218         let chanmon_cfgs = create_chanmon_cfgs(2);
7219         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7220         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7221         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7222
7223         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7224         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7225         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7226
7227         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7228         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7229         assert_eq!(remote_txn[0].output.len(), 4);
7230         assert_eq!(remote_txn[0].input.len(), 1);
7231         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7232
7233         // Claim a HTLC without revocation (provide B monitor with preimage)
7234         nodes[1].node.claim_funds(payment_preimage, &None, 3_000_000);
7235         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7236         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7237         check_added_monitors!(nodes[1], 2);
7238
7239         // One or more claim tx should have been broadcast, check it
7240         let timeout;
7241         let preimage;
7242         let feerate_timeout;
7243         let feerate_preimage;
7244         {
7245                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7246                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7247                 assert_eq!(node_txn[0].input.len(), 1);
7248                 assert_eq!(node_txn[1].input.len(), 1);
7249                 check_spends!(node_txn[0], remote_txn[0]);
7250                 check_spends!(node_txn[1], remote_txn[0]);
7251                 check_spends!(node_txn[2], chan.3);
7252                 check_spends!(node_txn[3], node_txn[2]);
7253                 check_spends!(node_txn[4], node_txn[2]);
7254                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7255                         timeout = node_txn[0].txid();
7256                         let index = node_txn[0].input[0].previous_output.vout;
7257                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7258                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7259
7260                         preimage = node_txn[1].txid();
7261                         let index = node_txn[1].input[0].previous_output.vout;
7262                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7263                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7264                 } else {
7265                         timeout = node_txn[1].txid();
7266                         let index = node_txn[1].input[0].previous_output.vout;
7267                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7268                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7269
7270                         preimage = node_txn[0].txid();
7271                         let index = node_txn[0].input[0].previous_output.vout;
7272                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7273                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7274                 }
7275                 node_txn.clear();
7276         };
7277         assert_ne!(feerate_timeout, 0);
7278         assert_ne!(feerate_preimage, 0);
7279
7280         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7281         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
7282         {
7283                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7284                 assert_eq!(node_txn.len(), 2);
7285                 assert_eq!(node_txn[0].input.len(), 1);
7286                 assert_eq!(node_txn[1].input.len(), 1);
7287                 check_spends!(node_txn[0], remote_txn[0]);
7288                 check_spends!(node_txn[1], remote_txn[0]);
7289                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7290                         let index = node_txn[0].input[0].previous_output.vout;
7291                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7292                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7293                         assert!(new_feerate * 100 > feerate_timeout * 125);
7294                         assert_ne!(timeout, node_txn[0].txid());
7295
7296                         let index = node_txn[1].input[0].previous_output.vout;
7297                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7298                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7299                         assert!(new_feerate * 100 > feerate_preimage * 125);
7300                         assert_ne!(preimage, node_txn[1].txid());
7301                 } else {
7302                         let index = node_txn[1].input[0].previous_output.vout;
7303                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7304                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7305                         assert!(new_feerate * 100 > feerate_timeout * 125);
7306                         assert_ne!(timeout, node_txn[1].txid());
7307
7308                         let index = node_txn[0].input[0].previous_output.vout;
7309                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7310                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7311                         assert!(new_feerate * 100 > feerate_preimage * 125);
7312                         assert_ne!(preimage, node_txn[0].txid());
7313                 }
7314                 node_txn.clear();
7315         }
7316
7317         nodes[1].node.get_and_clear_pending_events();
7318         nodes[1].node.get_and_clear_pending_msg_events();
7319 }
7320
7321 #[test]
7322 fn test_set_outpoints_partial_claiming() {
7323         // - remote party claim tx, new bump tx
7324         // - disconnect remote claiming tx, new bump
7325         // - disconnect tx, see no tx anymore
7326         let chanmon_cfgs = create_chanmon_cfgs(2);
7327         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7328         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7329         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7330
7331         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7332         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7333         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7334
7335         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7336         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
7337         assert_eq!(remote_txn.len(), 3);
7338         assert_eq!(remote_txn[0].output.len(), 4);
7339         assert_eq!(remote_txn[0].input.len(), 1);
7340         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7341         check_spends!(remote_txn[1], remote_txn[0]);
7342         check_spends!(remote_txn[2], remote_txn[0]);
7343
7344         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7345         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7346         // Provide node A with both preimage
7347         nodes[0].node.claim_funds(payment_preimage_1, &None, 3_000_000);
7348         nodes[0].node.claim_funds(payment_preimage_2, &None, 3_000_000);
7349         check_added_monitors!(nodes[0], 2);
7350         nodes[0].node.get_and_clear_pending_events();
7351         nodes[0].node.get_and_clear_pending_msg_events();
7352
7353         // Connect blocks on node A commitment transaction
7354         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7355         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7356         check_closed_broadcast!(nodes[0], false);
7357         check_added_monitors!(nodes[0], 1);
7358         // Verify node A broadcast tx claiming both HTLCs
7359         {
7360                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7361                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7362                 assert_eq!(node_txn.len(), 4);
7363                 check_spends!(node_txn[0], remote_txn[0]);
7364                 check_spends!(node_txn[1], chan.3);
7365                 check_spends!(node_txn[2], node_txn[1]);
7366                 check_spends!(node_txn[3], node_txn[1]);
7367                 assert_eq!(node_txn[0].input.len(), 2);
7368                 node_txn.clear();
7369         }
7370
7371         // Connect blocks on node B
7372         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7373         check_closed_broadcast!(nodes[1], false);
7374         check_added_monitors!(nodes[1], 1);
7375         // Verify node B broadcast 2 HTLC-timeout txn
7376         let partial_claim_tx = {
7377                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7378                 assert_eq!(node_txn.len(), 3);
7379                 check_spends!(node_txn[0], node_txn[2]);
7380                 check_spends!(node_txn[1], node_txn[2]);
7381                 assert_eq!(node_txn[0].input.len(), 1);
7382                 assert_eq!(node_txn[1].input.len(), 1);
7383                 node_txn[0].clone()
7384         };
7385
7386         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7387         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7388         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7389         {
7390                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7391                 assert_eq!(node_txn.len(), 1);
7392                 check_spends!(node_txn[0], remote_txn[0]);
7393                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7394                 node_txn.clear();
7395         }
7396         nodes[0].node.get_and_clear_pending_msg_events();
7397
7398         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7399         nodes[0].block_notifier.block_disconnected(&header, 102);
7400         {
7401                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7402                 assert_eq!(node_txn.len(), 1);
7403                 check_spends!(node_txn[0], remote_txn[0]);
7404                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7405                 node_txn.clear();
7406         }
7407
7408         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7409         nodes[0].block_notifier.block_disconnected(&header, 101);
7410         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7411         {
7412                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7413                 assert_eq!(node_txn.len(), 0);
7414                 node_txn.clear();
7415         }
7416 }
7417
7418 #[test]
7419 fn test_counterparty_raa_skip_no_crash() {
7420         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7421         // commitment transaction, we would have happily carried on and provided them the next
7422         // commitment transaction based on one RAA forward. This would probably eventually have led to
7423         // channel closure, but it would not have resulted in funds loss. Still, our
7424         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7425         // check simply that the channel is closed in response to such an RAA, but don't check whether
7426         // we decide to punish our counterparty for revoking their funds (as we don't currently
7427         // implement that).
7428         let chanmon_cfgs = create_chanmon_cfgs(2);
7429         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7430         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7431         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7432         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7433
7434         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7435         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7436         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7437                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7438         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7439
7440         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7441                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7442         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7443         check_added_monitors!(nodes[1], 1);
7444 }
7445
7446 #[test]
7447 fn test_bump_txn_sanitize_tracking_maps() {
7448         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7449         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7450
7451         let chanmon_cfgs = create_chanmon_cfgs(2);
7452         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7453         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7454         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7455
7456         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7457         // Lock HTLC in both directions
7458         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7459         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7460
7461         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7462         assert_eq!(revoked_local_txn[0].input.len(), 1);
7463         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7464
7465         // Revoke local commitment tx
7466         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7467
7468         // Broadcast set of revoked txn on A
7469         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7470         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7471         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7472         check_closed_broadcast!(nodes[0], false);
7473         check_added_monitors!(nodes[0], 1);
7474         let penalty_txn = {
7475                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7476                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7477                 check_spends!(node_txn[0], revoked_local_txn[0]);
7478                 check_spends!(node_txn[1], revoked_local_txn[0]);
7479                 check_spends!(node_txn[2], revoked_local_txn[0]);
7480                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7481                 node_txn.clear();
7482                 penalty_txn
7483         };
7484         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7485         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7486         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7487         {
7488                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7489                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7490                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
7491                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
7492                 }
7493         }
7494 }
7495
7496 #[test]
7497 fn test_override_channel_config() {
7498         let chanmon_cfgs = create_chanmon_cfgs(2);
7499         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7500         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7501         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7502
7503         // Node0 initiates a channel to node1 using the override config.
7504         let mut override_config = UserConfig::default();
7505         override_config.own_channel_config.our_to_self_delay = 200;
7506
7507         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7508
7509         // Assert the channel created by node0 is using the override config.
7510         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7511         assert_eq!(res.channel_flags, 0);
7512         assert_eq!(res.to_self_delay, 200);
7513 }
7514
7515 #[test]
7516 fn test_override_0msat_htlc_minimum() {
7517         let mut zero_config = UserConfig::default();
7518         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
7519         let chanmon_cfgs = create_chanmon_cfgs(2);
7520         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7521         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7522         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7523
7524         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7525         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7526         assert_eq!(res.htlc_minimum_msat, 1);
7527
7528         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &res);
7529         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7530         assert_eq!(res.htlc_minimum_msat, 1);
7531 }
7532
7533 #[test]
7534 fn test_simple_payment_secret() {
7535         // Simple test of sending a payment with a payment_secret present. This does not use any AMP
7536         // features, however.
7537         let chanmon_cfgs = create_chanmon_cfgs(3);
7538         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
7539         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
7540         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
7541
7542         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
7543         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
7544
7545         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7546         let payment_secret = PaymentSecret([0xdb; 32]);
7547         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7548         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[2]]], 100000, payment_hash, Some(payment_secret.clone()));
7549         // Claiming with all the correct values but the wrong secret should result in nothing...
7550         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &None, 100_000), false);
7551         assert_eq!(nodes[2].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 100_000), false);
7552         // ...but with the right secret we should be able to claim all the way back
7553         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[2]]], false, payment_preimage, Some(payment_secret.clone()), 100_000);
7554 }
7555
7556 #[test]
7557 fn test_simple_mpp() {
7558         // Simple test of sending a multi-path payment.
7559         let chanmon_cfgs = create_chanmon_cfgs(4);
7560         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
7561         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
7562         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
7563
7564         let chan_1_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7565         let chan_2_id = create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7566         let chan_3_id = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7567         let chan_4_id = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
7568
7569         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(&nodes[0]);
7570         let payment_secret = PaymentSecret([0xdb; 32]);
7571         let mut route = nodes[0].router.get_route(&nodes[3].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
7572         let path = route.paths[0].clone();
7573         route.paths.push(path);
7574         route.paths[0][0].pubkey = nodes[1].node.get_our_node_id();
7575         route.paths[0][0].short_channel_id = chan_1_id;
7576         route.paths[0][1].short_channel_id = chan_3_id;
7577         route.paths[1][0].pubkey = nodes[2].node.get_our_node_id();
7578         route.paths[1][0].short_channel_id = chan_2_id;
7579         route.paths[1][1].short_channel_id = chan_4_id;
7580         send_along_route_with_secret(&nodes[0], route, &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], 200_000, payment_hash, Some(payment_secret.clone()));
7581         // Claiming with all the correct values but the wrong secret should result in nothing...
7582         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &None, 200_000), false);
7583         assert_eq!(nodes[3].node.claim_funds(payment_preimage, &Some(PaymentSecret([42; 32])), 200_000), false);
7584         // ...but with the right secret we should be able to claim all the way back
7585         claim_payment_along_route_with_secret(&nodes[0], &[&[&nodes[1], &nodes[3]], &[&nodes[2], &nodes[3]]], false, payment_preimage, Some(payment_secret), 200_000);
7586 }