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