_ 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, 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).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).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).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         if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
 865         else { panic!("New sends should fail!") };
 866         if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
 867         else { panic!("New sends should fail!") };
 868
 869         assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
 870         check_added_monitors!(nodes[2], 1);
 871         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 872         assert!(updates.update_add_htlcs.is_empty());
 873         assert!(updates.update_fail_htlcs.is_empty());
 874         assert!(updates.update_fail_malformed_htlcs.is_empty());
 875         assert!(updates.update_fee.is_none());
 876         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 877         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
 878         check_added_monitors!(nodes[1], 1);
 879         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 880         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 881
 882         assert!(updates_2.update_add_htlcs.is_empty());
 883         assert!(updates_2.update_fail_htlcs.is_empty());
 884         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 885         assert!(updates_2.update_fee.is_none());
 886         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 887         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
 888         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 889
 890         let events = nodes[0].node.get_and_clear_pending_events();
 891         assert_eq!(events.len(), 1);
 892         match events[0] {
 893                 Event::PaymentSent { ref payment_preimage } => {
 894                         assert_eq!(our_payment_preimage, *payment_preimage);
 895                 },
 896                 _ => panic!("Unexpected event"),
 897         }
 898
 899         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 900         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 901         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 902         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 903         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 904         assert!(node_0_none.is_none());
 905
 906         assert!(nodes[0].node.list_channels().is_empty());
 907
 908         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 909         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 910         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 911         assert!(nodes[1].node.list_channels().is_empty());
 912         assert!(nodes[2].node.list_channels().is_empty());
 913 }
 914
 915 #[test]
 916 fn htlc_fail_async_shutdown() {
 917         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 918         let chanmon_cfgs = create_chanmon_cfgs(3);
 919         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
 920         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
 921         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
 922         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
 923         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
 924
 925         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 926         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 927         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
 928         check_added_monitors!(nodes[0], 1);
 929         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 930         assert_eq!(updates.update_add_htlcs.len(), 1);
 931         assert!(updates.update_fulfill_htlcs.is_empty());
 932         assert!(updates.update_fail_htlcs.is_empty());
 933         assert!(updates.update_fail_malformed_htlcs.is_empty());
 934         assert!(updates.update_fee.is_none());
 935
 936         nodes[1].node.close_channel(&chan_1.2).unwrap();
 937         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 938         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
 939         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 940
 941         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
 942         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
 943         check_added_monitors!(nodes[1], 1);
 944         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
 945         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 946
 947         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 948         assert!(updates_2.update_add_htlcs.is_empty());
 949         assert!(updates_2.update_fulfill_htlcs.is_empty());
 950         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 951         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 952         assert!(updates_2.update_fee.is_none());
 953
 954         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]);
 955         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 956
 957         let events = nodes[0].node.get_and_clear_pending_events();
 958         assert_eq!(events.len(), 1);
 959         match events[0] {
 960                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
 961                         assert_eq!(our_payment_hash, *payment_hash);
 962                         assert!(!rejected_by_dest);
 963                 },
 964                 _ => panic!("Unexpected event"),
 965         }
 966
 967         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 968         assert_eq!(msg_events.len(), 2);
 969         let node_0_closing_signed = match msg_events[0] {
 970                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 971                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 972                         (*msg).clone()
 973                 },
 974                 _ => panic!("Unexpected event"),
 975         };
 976         match msg_events[1] {
 977                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 978                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 979                 },
 980                 _ => panic!("Unexpected event"),
 981         }
 982
 983         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 984         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
 985         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 986         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
 987         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 988         assert!(node_0_none.is_none());
 989
 990         assert!(nodes[0].node.list_channels().is_empty());
 991
 992         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 993         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 994         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 995         assert!(nodes[1].node.list_channels().is_empty());
 996         assert!(nodes[2].node.list_channels().is_empty());
 997 }
 998
 999 fn do_test_shutdown_rebroadcast(recv_count: u8) {
1000         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
1001         // messages delivered prior to disconnect
1002         let chanmon_cfgs = create_chanmon_cfgs(3);
1003         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1004         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1005         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1006         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1007         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1008
1009         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
1010
1011         nodes[1].node.close_channel(&chan_1.2).unwrap();
1012         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1013         if recv_count > 0 {
1014                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown);
1015                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1016                 if recv_count > 1 {
1017                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
1018                 }
1019         }
1020
1021         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1022         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1023
1024         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1025         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1026         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1027         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1028
1029         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish);
1030         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1031         assert!(node_1_shutdown == node_1_2nd_shutdown);
1032
1033         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish);
1034         let node_0_2nd_shutdown = if recv_count > 0 {
1035                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1036                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1037                 node_0_2nd_shutdown
1038         } else {
1039                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1040                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown);
1041                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
1042         };
1043         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown);
1044
1045         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1046         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1047
1048         assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
1049         check_added_monitors!(nodes[2], 1);
1050         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1051         assert!(updates.update_add_htlcs.is_empty());
1052         assert!(updates.update_fail_htlcs.is_empty());
1053         assert!(updates.update_fail_malformed_htlcs.is_empty());
1054         assert!(updates.update_fee.is_none());
1055         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
1056         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
1057         check_added_monitors!(nodes[1], 1);
1058         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1059         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
1060
1061         assert!(updates_2.update_add_htlcs.is_empty());
1062         assert!(updates_2.update_fail_htlcs.is_empty());
1063         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
1064         assert!(updates_2.update_fee.is_none());
1065         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
1066         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]);
1067         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
1068
1069         let events = nodes[0].node.get_and_clear_pending_events();
1070         assert_eq!(events.len(), 1);
1071         match events[0] {
1072                 Event::PaymentSent { ref payment_preimage } => {
1073                         assert_eq!(our_payment_preimage, *payment_preimage);
1074                 },
1075                 _ => panic!("Unexpected event"),
1076         }
1077
1078         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1079         if recv_count > 0 {
1080                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed);
1081                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1082                 assert!(node_1_closing_signed.is_some());
1083         }
1084
1085         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
1086         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
1087
1088         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1089         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
1090         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
1091         if recv_count == 0 {
1092                 // If all closing_signeds weren't delivered we can just resume where we left off...
1093                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
1094
1095                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish);
1096                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
1097                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
1098
1099                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1100                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
1101                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
1102
1103                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown);
1104                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1105
1106                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown);
1107                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
1108                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
1109
1110                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed);
1111                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
1112                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap());
1113                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
1114                 assert!(node_0_none.is_none());
1115         } else {
1116                 // If one node, however, received + responded with an identical closing_signed we end
1117                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
1118                 // There isn't really anything better we can do simply, but in the future we might
1119                 // explore storing a set of recently-closed channels that got disconnected during
1120                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
1121                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
1122                 // transaction.
1123                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1124
1125                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish);
1126                 let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
1127                 assert_eq!(msg_events.len(), 1);
1128                 if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
1129                         match action {
1130                                 &ErrorAction::SendErrorMessage { ref msg } => {
1131                                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
1132                                         assert_eq!(msg.channel_id, chan_1.2);
1133                                 },
1134                                 _ => panic!("Unexpected event!"),
1135                         }
1136                 } else { panic!("Needed SendErrorMessage close"); }
1137
1138                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
1139                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
1140                 // closing_signed so we do it ourselves
1141                 check_closed_broadcast!(nodes[0], false);
1142                 check_added_monitors!(nodes[0], 1);
1143         }
1144
1145         assert!(nodes[0].node.list_channels().is_empty());
1146
1147         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
1148         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
1149         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
1150         assert!(nodes[1].node.list_channels().is_empty());
1151         assert!(nodes[2].node.list_channels().is_empty());
1152 }
1153
1154 #[test]
1155 fn test_shutdown_rebroadcast() {
1156         do_test_shutdown_rebroadcast(0);
1157         do_test_shutdown_rebroadcast(1);
1158         do_test_shutdown_rebroadcast(2);
1159 }
1160
1161 #[test]
1162 fn fake_network_test() {
1163         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1164         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
1165         let chanmon_cfgs = create_chanmon_cfgs(4);
1166         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
1167         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
1168         let nodes = create_network(4, &node_cfgs, &node_chanmgrs);
1169
1170         // Create some initial channels
1171         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1172         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1173         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1174
1175         // Rebalance the network a bit by relaying one payment through all the channels...
1176         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1177         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1178         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1179         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1180
1181         // Send some more payments
1182         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1183         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1184         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1185
1186         // Test failure packets
1187         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1188         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1189
1190         // Add a new channel that skips 3
1191         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1192
1193         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1194         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1195         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1196         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1197         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1198         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1199         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1200
1201         // Do some rebalance loop payments, simultaneously
1202         let mut hops = Vec::with_capacity(3);
1203         hops.push(RouteHop {
1204                 pubkey: nodes[2].node.get_our_node_id(),
1205                 node_features: NodeFeatures::empty(),
1206                 short_channel_id: chan_2.0.contents.short_channel_id,
1207                 channel_features: ChannelFeatures::empty(),
1208                 fee_msat: 0,
1209                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1210         });
1211         hops.push(RouteHop {
1212                 pubkey: nodes[3].node.get_our_node_id(),
1213                 node_features: NodeFeatures::empty(),
1214                 short_channel_id: chan_3.0.contents.short_channel_id,
1215                 channel_features: ChannelFeatures::empty(),
1216                 fee_msat: 0,
1217                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1218         });
1219         hops.push(RouteHop {
1220                 pubkey: nodes[1].node.get_our_node_id(),
1221                 node_features: NodeFeatures::empty(),
1222                 short_channel_id: chan_4.0.contents.short_channel_id,
1223                 channel_features: ChannelFeatures::empty(),
1224                 fee_msat: 1000000,
1225                 cltv_expiry_delta: TEST_FINAL_CLTV,
1226         });
1227         hops[1].fee_msat = chan_4.1.contents.fee_base_msat as u64 + chan_4.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1228         hops[0].fee_msat = chan_3.0.contents.fee_base_msat as u64 + chan_3.0.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1229         let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1230
1231         let mut hops = Vec::with_capacity(3);
1232         hops.push(RouteHop {
1233                 pubkey: nodes[3].node.get_our_node_id(),
1234                 node_features: NodeFeatures::empty(),
1235                 short_channel_id: chan_4.0.contents.short_channel_id,
1236                 channel_features: ChannelFeatures::empty(),
1237                 fee_msat: 0,
1238                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1239         });
1240         hops.push(RouteHop {
1241                 pubkey: nodes[2].node.get_our_node_id(),
1242                 node_features: NodeFeatures::empty(),
1243                 short_channel_id: chan_3.0.contents.short_channel_id,
1244                 channel_features: ChannelFeatures::empty(),
1245                 fee_msat: 0,
1246                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1247         });
1248         hops.push(RouteHop {
1249                 pubkey: nodes[1].node.get_our_node_id(),
1250                 node_features: NodeFeatures::empty(),
1251                 short_channel_id: chan_2.0.contents.short_channel_id,
1252                 channel_features: ChannelFeatures::empty(),
1253                 fee_msat: 1000000,
1254                 cltv_expiry_delta: TEST_FINAL_CLTV,
1255         });
1256         hops[1].fee_msat = chan_2.1.contents.fee_base_msat as u64 + chan_2.1.contents.fee_proportional_millionths as u64 * hops[2].fee_msat as u64 / 1000000;
1257         hops[0].fee_msat = chan_3.1.contents.fee_base_msat as u64 + chan_3.1.contents.fee_proportional_millionths as u64 * hops[1].fee_msat as u64 / 1000000;
1258         let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1259
1260         // Claim the rebalances...
1261         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1262         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1263
1264         // Add a duplicate new channel from 2 to 4
1265         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1266
1267         // Send some payments across both channels
1268         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1269         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1270         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1271
1272
1273         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1274         let events = nodes[0].node.get_and_clear_pending_msg_events();
1275         assert_eq!(events.len(), 0);
1276         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
1277
1278         //TODO: Test that routes work again here as we've been notified that the channel is full
1279
1280         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1281         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1282         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1283
1284         // Close down the channels...
1285         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1286         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1287         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1288         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1289         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1290 }
1291
1292 #[test]
1293 fn holding_cell_htlc_counting() {
1294         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1295         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1296         // commitment dance rounds.
1297         let chanmon_cfgs = create_chanmon_cfgs(3);
1298         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1299         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1300         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1301         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1302         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1303
1304         let mut payments = Vec::new();
1305         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1306                 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1307                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1308                 nodes[1].node.send_payment(route, payment_hash).unwrap();
1309                 payments.push((payment_preimage, payment_hash));
1310         }
1311         check_added_monitors!(nodes[1], 1);
1312
1313         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1314         assert_eq!(events.len(), 1);
1315         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1316         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1317
1318         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1319         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1320         // another HTLC.
1321         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1322         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1323         if let APIError::ChannelUnavailable { err } = nodes[1].node.send_payment(route, payment_hash_1).unwrap_err() {
1324                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
1325         } else { panic!("Unexpected event"); }
1326         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1327         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot push more than their max accepted HTLCs".to_string(), 1);
1328
1329         // This should also be true if we try to forward a payment.
1330         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1331         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1332         nodes[0].node.send_payment(route, payment_hash_2).unwrap();
1333         check_added_monitors!(nodes[0], 1);
1334
1335         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1336         assert_eq!(events.len(), 1);
1337         let payment_event = SendEvent::from_event(events.pop().unwrap());
1338         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1339
1340         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
1341         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1342         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1343         // fails), the second will process the resulting failure and fail the HTLC backward.
1344         expect_pending_htlcs_forwardable!(nodes[1]);
1345         expect_pending_htlcs_forwardable!(nodes[1]);
1346         check_added_monitors!(nodes[1], 1);
1347
1348         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1349         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]);
1350         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1351
1352         let events = nodes[0].node.get_and_clear_pending_msg_events();
1353         assert_eq!(events.len(), 1);
1354         match events[0] {
1355                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1356                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1357                 },
1358                 _ => panic!("Unexpected event"),
1359         }
1360
1361         let events = nodes[0].node.get_and_clear_pending_events();
1362         assert_eq!(events.len(), 1);
1363         match events[0] {
1364                 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1365                         assert_eq!(payment_hash, payment_hash_2);
1366                         assert!(!rejected_by_dest);
1367                 },
1368                 _ => panic!("Unexpected event"),
1369         }
1370
1371         // Now forward all the pending HTLCs and claim them back
1372         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]);
1373         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg);
1374         check_added_monitors!(nodes[2], 1);
1375
1376         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1377         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1378         check_added_monitors!(nodes[1], 1);
1379         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1380
1381         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1382         check_added_monitors!(nodes[1], 1);
1383         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1384
1385         for ref update in as_updates.update_add_htlcs.iter() {
1386                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update);
1387         }
1388         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed);
1389         check_added_monitors!(nodes[2], 1);
1390         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
1391         check_added_monitors!(nodes[2], 1);
1392         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1393
1394         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack);
1395         check_added_monitors!(nodes[1], 1);
1396         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed);
1397         check_added_monitors!(nodes[1], 1);
1398         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1399
1400         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa);
1401         check_added_monitors!(nodes[2], 1);
1402
1403         expect_pending_htlcs_forwardable!(nodes[2]);
1404
1405         let events = nodes[2].node.get_and_clear_pending_events();
1406         assert_eq!(events.len(), payments.len());
1407         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1408                 match event {
1409                         &Event::PaymentReceived { ref payment_hash, .. } => {
1410                                 assert_eq!(*payment_hash, *hash);
1411                         },
1412                         _ => panic!("Unexpected event"),
1413                 };
1414         }
1415
1416         for (preimage, _) in payments.drain(..) {
1417                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1418         }
1419
1420         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1421 }
1422
1423 #[test]
1424 fn duplicate_htlc_test() {
1425         // Test that we accept duplicate payment_hash HTLCs across the network and that
1426         // claiming/failing them are all separate and don't affect each other
1427         let chanmon_cfgs = create_chanmon_cfgs(6);
1428         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
1429         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
1430         let mut nodes = create_network(6, &node_cfgs, &node_chanmgrs);
1431
1432         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1433         create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
1434         create_announced_chan_between_nodes(&nodes, 1, 3, InitFeatures::supported(), InitFeatures::supported());
1435         create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1436         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1437         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
1438
1439         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1440
1441         *nodes[0].network_payment_count.borrow_mut() -= 1;
1442         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1443
1444         *nodes[0].network_payment_count.borrow_mut() -= 1;
1445         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1446
1447         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1448         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1449         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1450 }
1451
1452 #[test]
1453 fn test_duplicate_htlc_different_direction_onchain() {
1454         // Test that ChannelMonitor doesn't generate 2 preimage txn
1455         // when we have 2 HTLCs with same preimage that go across a node
1456         // in opposite directions.
1457         let chanmon_cfgs = create_chanmon_cfgs(2);
1458         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1459         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1460         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1461
1462         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1463
1464         // balancing
1465         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1466
1467         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1468
1469         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1470         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1471
1472         // Provide preimage to node 0 by claiming payment
1473         nodes[0].node.claim_funds(payment_preimage, 800_000);
1474         check_added_monitors!(nodes[0], 1);
1475
1476         // Broadcast node 1 commitment txn
1477         let remote_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
1478
1479         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1480         let mut has_both_htlcs = 0; // check htlcs match ones committed
1481         for outp in remote_txn[0].output.iter() {
1482                 if outp.value == 800_000 / 1000 {
1483                         has_both_htlcs += 1;
1484                 } else if outp.value == 900_000 / 1000 {
1485                         has_both_htlcs += 1;
1486                 }
1487         }
1488         assert_eq!(has_both_htlcs, 2);
1489
1490         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1491         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1492         check_added_monitors!(nodes[0], 1);
1493
1494         // Check we only broadcast 1 timeout tx
1495         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1496         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()) };
1497         assert_eq!(claim_txn.len(), 5);
1498         check_spends!(claim_txn[2], chan_1.3);
1499         check_spends!(claim_txn[3], claim_txn[2]);
1500         assert_eq!(htlc_pair.0.input.len(), 1);
1501         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1502         check_spends!(htlc_pair.0, remote_txn[0]);
1503         assert_eq!(htlc_pair.1.input.len(), 1);
1504         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1505         check_spends!(htlc_pair.1, remote_txn[0]);
1506
1507         let events = nodes[0].node.get_and_clear_pending_msg_events();
1508         assert_eq!(events.len(), 2);
1509         for e in events {
1510                 match e {
1511                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1512                         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, .. } } => {
1513                                 assert!(update_add_htlcs.is_empty());
1514                                 assert!(update_fail_htlcs.is_empty());
1515                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1516                                 assert!(update_fail_malformed_htlcs.is_empty());
1517                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1518                         },
1519                         _ => panic!("Unexpected event"),
1520                 }
1521         }
1522 }
1523
1524 fn do_channel_reserve_test(test_recv: bool) {
1525
1526         let chanmon_cfgs = create_chanmon_cfgs(3);
1527         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
1528         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
1529         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
1530         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1531         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, InitFeatures::supported(), InitFeatures::supported());
1532
1533         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1534         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1535
1536         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1537         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1538
1539         macro_rules! get_route_and_payment_hash {
1540                 ($recv_value: expr) => {{
1541                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1542                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1543                         (route, payment_hash, payment_preimage)
1544                 }}
1545         };
1546
1547         macro_rules! expect_forward {
1548                 ($node: expr) => {{
1549                         let mut events = $node.node.get_and_clear_pending_msg_events();
1550                         assert_eq!(events.len(), 1);
1551                         check_added_monitors!($node, 1);
1552                         let payment_event = SendEvent::from_event(events.remove(0));
1553                         payment_event
1554                 }}
1555         }
1556
1557         let feemsat = 239; // somehow we know?
1558         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1559
1560         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1561
1562         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1563         {
1564                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1565                 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1566                 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
1567                 match err {
1568                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
1569                         _ => panic!("Unknown error variants"),
1570                 }
1571                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1572                 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);
1573         }
1574
1575         let mut htlc_id = 0;
1576         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1577         // nodes[0]'s wealth
1578         loop {
1579                 let amt_msat = recv_value_0 + total_fee_msat;
1580                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1581                         break;
1582                 }
1583                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1584                 htlc_id += 1;
1585
1586                 let (stat01_, stat11_, stat12_, stat22_) = (
1587                         get_channel_value_stat!(nodes[0], chan_1.2),
1588                         get_channel_value_stat!(nodes[1], chan_1.2),
1589                         get_channel_value_stat!(nodes[1], chan_2.2),
1590                         get_channel_value_stat!(nodes[2], chan_2.2),
1591                 );
1592
1593                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1594                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1595                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1596                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1597                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1598         }
1599
1600         {
1601                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1602                 // attempt to get channel_reserve violation
1603                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1604                 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
1605                 match err {
1606                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1607                         _ => panic!("Unknown error variants"),
1608                 }
1609                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1610                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 1);
1611         }
1612
1613         // adding pending output
1614         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1615         let amt_msat_1 = recv_value_1 + total_fee_msat;
1616
1617         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1618         let payment_event_1 = {
1619                 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
1620                 check_added_monitors!(nodes[0], 1);
1621
1622                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1623                 assert_eq!(events.len(), 1);
1624                 SendEvent::from_event(events.remove(0))
1625         };
1626         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]);
1627
1628         // channel reserve test with htlc pending output > 0
1629         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1630         {
1631                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1632                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1633                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1634                         _ => panic!("Unknown error variants"),
1635                 }
1636                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1637                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 2);
1638         }
1639
1640         {
1641                 // test channel_reserve test on nodes[1] side
1642                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1643
1644                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1645                 let secp_ctx = Secp256k1::new();
1646                 let session_priv = SecretKey::from_slice(&{
1647                         let mut session_key = [0; 32];
1648                         let mut rng = thread_rng();
1649                         rng.fill_bytes(&mut session_key);
1650                         session_key
1651                 }).expect("RNG is bad!");
1652
1653                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1654                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1655                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
1656                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
1657                 let msg = msgs::UpdateAddHTLC {
1658                         channel_id: chan_1.2,
1659                         htlc_id,
1660                         amount_msat: htlc_msat,
1661                         payment_hash: our_payment_hash,
1662                         cltv_expiry: htlc_cltv,
1663                         onion_routing_packet: onion_packet,
1664                 };
1665
1666                 if test_recv {
1667                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
1668                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1669                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1670                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1671                         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
1672                         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
1673                         check_added_monitors!(nodes[1], 1);
1674                         return;
1675                 }
1676         }
1677
1678         // split the rest to test holding cell
1679         let recv_value_21 = recv_value_2/2;
1680         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1681         {
1682                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1683                 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);
1684         }
1685
1686         // now see if they go through on both sides
1687         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1688         // but this will stuck in the holding cell
1689         nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
1690         check_added_monitors!(nodes[0], 0);
1691         let events = nodes[0].node.get_and_clear_pending_events();
1692         assert_eq!(events.len(), 0);
1693
1694         // test with outbound holding cell amount > 0
1695         {
1696                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1697                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1698                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1699                         _ => panic!("Unknown error variants"),
1700                 }
1701                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1702                 nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over their reserve value".to_string(), 3);
1703         }
1704
1705         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1706         // this will also stuck in the holding cell
1707         nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
1708         check_added_monitors!(nodes[0], 0);
1709         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1710         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1711
1712         // flush the pending htlc
1713         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg);
1714         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1715         check_added_monitors!(nodes[1], 1);
1716
1717         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack);
1718         check_added_monitors!(nodes[0], 1);
1719         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1720
1721         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed);
1722         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1723         // No commitment_signed so get_event_msg's assert(len == 1) passes
1724         check_added_monitors!(nodes[0], 1);
1725
1726         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack);
1727         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1728         check_added_monitors!(nodes[1], 1);
1729
1730         expect_pending_htlcs_forwardable!(nodes[1]);
1731
1732         let ref payment_event_11 = expect_forward!(nodes[1]);
1733         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]);
1734         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1735
1736         expect_pending_htlcs_forwardable!(nodes[2]);
1737         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1738
1739         // flush the htlcs in the holding cell
1740         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1741         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]);
1742         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]);
1743         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1744         expect_pending_htlcs_forwardable!(nodes[1]);
1745
1746         let ref payment_event_3 = expect_forward!(nodes[1]);
1747         assert_eq!(payment_event_3.msgs.len(), 2);
1748         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]);
1749         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]);
1750
1751         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1752         expect_pending_htlcs_forwardable!(nodes[2]);
1753
1754         let events = nodes[2].node.get_and_clear_pending_events();
1755         assert_eq!(events.len(), 2);
1756         match events[0] {
1757                 Event::PaymentReceived { ref payment_hash, amt } => {
1758                         assert_eq!(our_payment_hash_21, *payment_hash);
1759                         assert_eq!(recv_value_21, amt);
1760                 },
1761                 _ => panic!("Unexpected event"),
1762         }
1763         match events[1] {
1764                 Event::PaymentReceived { ref payment_hash, amt } => {
1765                         assert_eq!(our_payment_hash_22, *payment_hash);
1766                         assert_eq!(recv_value_22, amt);
1767                 },
1768                 _ => panic!("Unexpected event"),
1769         }
1770
1771         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1772         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1773         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1774
1775         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);
1776         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1777         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1778         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1779
1780         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1781         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1782 }
1783
1784 #[test]
1785 fn channel_reserve_test() {
1786         do_channel_reserve_test(false);
1787         do_channel_reserve_test(true);
1788 }
1789
1790 #[test]
1791 fn channel_reserve_in_flight_removes() {
1792         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1793         // can send to its counterparty, but due to update ordering, the other side may not yet have
1794         // considered those HTLCs fully removed.
1795         // This tests that we don't count HTLCs which will not be included in the next remote
1796         // commitment transaction towards the reserve value (as it implies no commitment transaction
1797         // will be generated which violates the remote reserve value).
1798         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1799         // To test this we:
1800         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1801         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1802         //    you only consider the value of the first HTLC, it may not),
1803         //  * start routing a third HTLC from A to B,
1804         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1805         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1806         //  * deliver the first fulfill from B
1807         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1808         //    claim,
1809         //  * deliver A's response CS and RAA.
1810         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1811         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1812         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1813         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1814         let chanmon_cfgs = create_chanmon_cfgs(2);
1815         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
1816         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
1817         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
1818         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1819
1820         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1821         // Route the first two HTLCs.
1822         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1823         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1824
1825         // Start routing the third HTLC (this is just used to get everyone in the right state).
1826         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1827         let send_1 = {
1828                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1829                 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
1830                 check_added_monitors!(nodes[0], 1);
1831                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1832                 assert_eq!(events.len(), 1);
1833                 SendEvent::from_event(events.remove(0))
1834         };
1835
1836         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1837         // initial fulfill/CS.
1838         assert!(nodes[1].node.claim_funds(payment_preimage_1, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1839         check_added_monitors!(nodes[1], 1);
1840         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1841
1842         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1843         // remove the second HTLC when we send the HTLC back from B to A.
1844         assert!(nodes[1].node.claim_funds(payment_preimage_2, 20000));
1845         check_added_monitors!(nodes[1], 1);
1846         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1847
1848         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]);
1849         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed);
1850         check_added_monitors!(nodes[0], 1);
1851         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1852         expect_payment_sent!(nodes[0], payment_preimage_1);
1853
1854         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]);
1855         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg);
1856         check_added_monitors!(nodes[1], 1);
1857         // B is already AwaitingRAA, so cant generate a CS here
1858         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1859
1860         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1861         check_added_monitors!(nodes[1], 1);
1862         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1863
1864         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1865         check_added_monitors!(nodes[0], 1);
1866         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1867
1868         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1869         check_added_monitors!(nodes[1], 1);
1870         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1871
1872         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1873         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1874         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1875         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1876         // on-chain as necessary).
1877         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]);
1878         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed);
1879         check_added_monitors!(nodes[0], 1);
1880         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1881         expect_payment_sent!(nodes[0], payment_preimage_2);
1882
1883         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1884         check_added_monitors!(nodes[1], 1);
1885         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1886
1887         expect_pending_htlcs_forwardable!(nodes[1]);
1888         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1889
1890         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1891         // resolve the second HTLC from A's point of view.
1892         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1893         check_added_monitors!(nodes[0], 1);
1894         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1895
1896         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1897         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1898         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1899         let send_2 = {
1900                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1901                 nodes[1].node.send_payment(route, payment_hash_4).unwrap();
1902                 check_added_monitors!(nodes[1], 1);
1903                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1904                 assert_eq!(events.len(), 1);
1905                 SendEvent::from_event(events.remove(0))
1906         };
1907
1908         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]);
1909         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg);
1910         check_added_monitors!(nodes[0], 1);
1911         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1912
1913         // Now just resolve all the outstanding messages/HTLCs for completeness...
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[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa);
1920         check_added_monitors!(nodes[1], 1);
1921
1922         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1923         check_added_monitors!(nodes[0], 1);
1924         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1925
1926         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed);
1927         check_added_monitors!(nodes[1], 1);
1928         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1929
1930         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa);
1931         check_added_monitors!(nodes[0], 1);
1932
1933         expect_pending_htlcs_forwardable!(nodes[0]);
1934         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1935
1936         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1937         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1938 }
1939
1940 #[test]
1941 fn channel_monitor_network_test() {
1942         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1943         // tests that ChannelMonitor is able to recover from various states.
1944         let chanmon_cfgs = create_chanmon_cfgs(5);
1945         let node_cfgs = create_node_cfgs(5, &chanmon_cfgs);
1946         let node_chanmgrs = create_node_chanmgrs(5, &node_cfgs, &[None, None, None, None, None]);
1947         let nodes = create_network(5, &node_cfgs, &node_chanmgrs);
1948
1949         // Create some initial channels
1950         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
1951         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
1952         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
1953         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
1954
1955         // Rebalance the network a bit by relaying one payment through all the channels...
1956         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1957         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1958         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1959         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1960
1961         // Simple case with no pending HTLCs:
1962         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1963         check_added_monitors!(nodes[1], 1);
1964         {
1965                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1966                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1967                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1968                 check_added_monitors!(nodes[0], 1);
1969                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1970         }
1971         get_announce_close_broadcast_events(&nodes, 0, 1);
1972         assert_eq!(nodes[0].node.list_channels().len(), 0);
1973         assert_eq!(nodes[1].node.list_channels().len(), 1);
1974
1975         // One pending HTLC is discarded by the force-close:
1976         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1977
1978         // Simple case of one pending HTLC to HTLC-Timeout
1979         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1980         check_added_monitors!(nodes[1], 1);
1981         {
1982                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1983                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1984                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1985                 check_added_monitors!(nodes[2], 1);
1986                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1987         }
1988         get_announce_close_broadcast_events(&nodes, 1, 2);
1989         assert_eq!(nodes[1].node.list_channels().len(), 0);
1990         assert_eq!(nodes[2].node.list_channels().len(), 1);
1991
1992         macro_rules! claim_funds {
1993                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1994                         {
1995                                 assert!($node.node.claim_funds($preimage, $amount));
1996                                 check_added_monitors!($node, 1);
1997
1998                                 let events = $node.node.get_and_clear_pending_msg_events();
1999                                 assert_eq!(events.len(), 1);
2000                                 match events[0] {
2001                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
2002                                                 assert!(update_add_htlcs.is_empty());
2003                                                 assert!(update_fail_htlcs.is_empty());
2004                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
2005                                         },
2006                                         _ => panic!("Unexpected event"),
2007                                 };
2008                         }
2009                 }
2010         }
2011
2012         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
2013         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
2014         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
2015         check_added_monitors!(nodes[2], 1);
2016         let node2_commitment_txid;
2017         {
2018                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
2019                 node2_commitment_txid = node_txn[0].txid();
2020
2021                 // Claim the payment on nodes[3], giving it knowledge of the preimage
2022                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
2023
2024                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2025                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
2026                 check_added_monitors!(nodes[3], 1);
2027
2028                 check_preimage_claim(&nodes[3], &node_txn);
2029         }
2030         get_announce_close_broadcast_events(&nodes, 2, 3);
2031         assert_eq!(nodes[2].node.list_channels().len(), 0);
2032         assert_eq!(nodes[3].node.list_channels().len(), 1);
2033
2034         { // Cheat and reset nodes[4]'s height to 1
2035                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2036                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
2037         }
2038
2039         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
2040         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
2041         // One pending HTLC to time out:
2042         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
2043         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
2044         // buffer space).
2045
2046         {
2047                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2048                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2049                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
2050                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2051                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2052                 }
2053                 check_added_monitors!(nodes[3], 1);
2054
2055                 // Clear bumped claiming txn spending node 2 commitment tx. Bumped txn are generated after reaching some height timer.
2056                 {
2057                         let mut node_txn = nodes[3].tx_broadcaster.txn_broadcasted.lock().unwrap();
2058                         node_txn.retain(|tx| {
2059                                 if tx.input[0].previous_output.txid == node2_commitment_txid {
2060                                         false
2061                                 } else { true }
2062                         });
2063                 }
2064
2065                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
2066
2067                 // Claim the payment on nodes[4], giving it knowledge of the preimage
2068                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
2069
2070                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2071
2072                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
2073                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
2074                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2075                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
2076                 }
2077
2078                 check_added_monitors!(nodes[4], 1);
2079                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
2080
2081                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2082                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
2083
2084                 check_preimage_claim(&nodes[4], &node_txn);
2085         }
2086         get_announce_close_broadcast_events(&nodes, 3, 4);
2087         assert_eq!(nodes[3].node.list_channels().len(), 0);
2088         assert_eq!(nodes[4].node.list_channels().len(), 0);
2089 }
2090
2091 #[test]
2092 fn test_justice_tx() {
2093         // Test justice txn built on revoked HTLC-Success tx, against both sides
2094         let mut alice_config = UserConfig::default();
2095         alice_config.channel_options.announced_channel = true;
2096         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
2097         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
2098         let mut bob_config = UserConfig::default();
2099         bob_config.channel_options.announced_channel = true;
2100         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
2101         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
2102         let user_cfgs = [Some(alice_config), Some(bob_config)];
2103         let chanmon_cfgs = create_chanmon_cfgs(2);
2104         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2105         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
2106         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2107         // Create some new channels:
2108         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2109
2110         // A pending HTLC which will be revoked:
2111         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2112         // Get the will-be-revoked local txn from nodes[0]
2113         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_5.2);
2114         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
2115         assert_eq!(revoked_local_txn[0].input.len(), 1);
2116         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
2117         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
2118         assert_eq!(revoked_local_txn[1].input.len(), 1);
2119         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2120         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2121         // Revoke the old state
2122         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
2123
2124         {
2125                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2126                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2127                 {
2128                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2129                         assert_eq!(node_txn.len(), 2); // ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2130                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
2131
2132                         check_spends!(node_txn[0], revoked_local_txn[0]);
2133                         node_txn.swap_remove(0);
2134                         node_txn.truncate(1);
2135                 }
2136                 check_added_monitors!(nodes[1], 1);
2137                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
2138
2139                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2140                 // Verify broadcast of revoked HTLC-timeout
2141                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
2142                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2143                 check_added_monitors!(nodes[0], 1);
2144                 // Broadcast revoked HTLC-timeout on node 1
2145                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2146                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone(), revoked_local_txn[0].clone());
2147         }
2148         get_announce_close_broadcast_events(&nodes, 0, 1);
2149
2150         assert_eq!(nodes[0].node.list_channels().len(), 0);
2151         assert_eq!(nodes[1].node.list_channels().len(), 0);
2152
2153         // We test justice_tx build by A on B's revoked HTLC-Success tx
2154         // Create some new channels:
2155         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2156         {
2157                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2158                 node_txn.clear();
2159         }
2160
2161         // A pending HTLC which will be revoked:
2162         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2163         // Get the will-be-revoked local txn from B
2164         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_6.2);
2165         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
2166         assert_eq!(revoked_local_txn[0].input.len(), 1);
2167         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
2168         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
2169         // Revoke the old state
2170         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
2171         {
2172                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2173                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2174                 {
2175                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2176                         assert_eq!(node_txn.len(), 2); //ChannelMonitor: penalty tx, ChannelManager: local commitment tx
2177                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
2178
2179                         check_spends!(node_txn[0], revoked_local_txn[0]);
2180                         node_txn.swap_remove(0);
2181                 }
2182                 check_added_monitors!(nodes[0], 1);
2183                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
2184
2185                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2186                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
2187                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2188                 check_added_monitors!(nodes[1], 1);
2189                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
2190                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone(), revoked_local_txn[0].clone());
2191         }
2192         get_announce_close_broadcast_events(&nodes, 0, 1);
2193         assert_eq!(nodes[0].node.list_channels().len(), 0);
2194         assert_eq!(nodes[1].node.list_channels().len(), 0);
2195 }
2196
2197 #[test]
2198 fn revoked_output_claim() {
2199         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
2200         // transaction is broadcast by its counterparty
2201         let chanmon_cfgs = create_chanmon_cfgs(2);
2202         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2203         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2204         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2205         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2206         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
2207         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2208         assert_eq!(revoked_local_txn.len(), 1);
2209         // Only output is the full channel value back to nodes[0]:
2210         assert_eq!(revoked_local_txn[0].output.len(), 1);
2211         // Send a payment through, updating everyone's latest commitment txn
2212         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
2213
2214         // Inform nodes[1] that nodes[0] broadcast a stale tx
2215         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2216         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2217         check_added_monitors!(nodes[1], 1);
2218         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2219         assert_eq!(node_txn.len(), 2); // ChannelMonitor: justice tx against revoked to_local output, ChannelManager: local commitment tx
2220
2221         check_spends!(node_txn[0], revoked_local_txn[0]);
2222         check_spends!(node_txn[1], chan_1.3);
2223
2224         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
2225         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2226         get_announce_close_broadcast_events(&nodes, 0, 1);
2227         check_added_monitors!(nodes[0], 1)
2228 }
2229
2230 #[test]
2231 fn claim_htlc_outputs_shared_tx() {
2232         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
2233         let chanmon_cfgs = create_chanmon_cfgs(2);
2234         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2235         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2236         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2237
2238         // Create some new channel:
2239         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2240
2241         // Rebalance the network to generate htlc in the two directions
2242         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2243         // 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
2244         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2245         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2246
2247         // Get the will-be-revoked local txn from node[0]
2248         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2249         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
2250         assert_eq!(revoked_local_txn[0].input.len(), 1);
2251         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
2252         assert_eq!(revoked_local_txn[1].input.len(), 1);
2253         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
2254         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
2255         check_spends!(revoked_local_txn[1], revoked_local_txn[0]);
2256
2257         //Revoke the old state
2258         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2259
2260         {
2261                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2262                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2263                 check_added_monitors!(nodes[0], 1);
2264                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2265                 check_added_monitors!(nodes[1], 1);
2266                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2267
2268                 let events = nodes[1].node.get_and_clear_pending_events();
2269                 assert_eq!(events.len(), 1);
2270                 match events[0] {
2271                         Event::PaymentFailed { payment_hash, .. } => {
2272                                 assert_eq!(payment_hash, payment_hash_2);
2273                         },
2274                         _ => panic!("Unexpected event"),
2275                 }
2276
2277                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2278                 assert_eq!(node_txn.len(), 3); // ChannelMonitor: penalty tx, ChannelManager: local commitment + HTLC-timeout
2279
2280                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2281                 check_spends!(node_txn[0], revoked_local_txn[0]);
2282
2283                 let mut witness_lens = BTreeSet::new();
2284                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2285                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2286                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2287                 assert_eq!(witness_lens.len(), 3);
2288                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2289                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2290                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2291
2292                 // Next nodes[1] broadcasts its current local tx state:
2293                 assert_eq!(node_txn[1].input.len(), 1);
2294                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2295
2296                 assert_eq!(node_txn[2].input.len(), 1);
2297                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2298                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2299                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2300                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2301                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2302         }
2303         get_announce_close_broadcast_events(&nodes, 0, 1);
2304         assert_eq!(nodes[0].node.list_channels().len(), 0);
2305         assert_eq!(nodes[1].node.list_channels().len(), 0);
2306 }
2307
2308 #[test]
2309 fn claim_htlc_outputs_single_tx() {
2310         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2311         let chanmon_cfgs = create_chanmon_cfgs(2);
2312         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2313         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2314         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2315
2316         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2317
2318         // Rebalance the network to generate htlc in the two directions
2319         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2320         // 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
2321         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2322         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2323         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2324
2325         // Get the will-be-revoked local txn from node[0]
2326         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
2327
2328         //Revoke the old state
2329         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2330
2331         {
2332                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2333                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2334                 check_added_monitors!(nodes[0], 1);
2335                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2336                 check_added_monitors!(nodes[1], 1);
2337                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2338
2339                 let events = nodes[1].node.get_and_clear_pending_events();
2340                 assert_eq!(events.len(), 1);
2341                 match events[0] {
2342                         Event::PaymentFailed { payment_hash, .. } => {
2343                                 assert_eq!(payment_hash, payment_hash_2);
2344                         },
2345                         _ => panic!("Unexpected event"),
2346                 }
2347
2348                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2349                 assert_eq!(node_txn.len(), 21);
2350                 // ChannelMonitor: justice tx revoked offered htlc, justice tx revoked received htlc, justice tx revoked to_local (3)
2351                 // ChannelManager: local commmitment + local HTLC-timeout (2)
2352                 // ChannelMonitor: bumped justice tx (4), after one increase, bumps on HTLC aren't generated not being substantial anymore
2353                 // ChannelMonito r: local commitment + local HTLC-timeout (14)
2354
2355                 assert_eq!(node_txn[0], node_txn[5]);
2356                 assert_eq!(node_txn[0], node_txn[7]);
2357                 assert_eq!(node_txn[0], node_txn[9]);
2358                 assert_eq!(node_txn[0], node_txn[13]);
2359                 assert_eq!(node_txn[0], node_txn[15]);
2360                 assert_eq!(node_txn[0], node_txn[17]);
2361                 assert_eq!(node_txn[0], node_txn[19]);
2362
2363                 assert_eq!(node_txn[1], node_txn[6]);
2364                 assert_eq!(node_txn[1], node_txn[8]);
2365                 assert_eq!(node_txn[1], node_txn[10]);
2366                 assert_eq!(node_txn[1], node_txn[14]);
2367                 assert_eq!(node_txn[1], node_txn[16]);
2368                 assert_eq!(node_txn[1], node_txn[18]);
2369                 assert_eq!(node_txn[1], node_txn[20]);
2370
2371
2372                 // Check the pair local commitment and HTLC-timeout broadcast due to HTLC expiration and present 8 times (rebroadcast at every block from 200 to 206)
2373                 assert_eq!(node_txn[0].input.len(), 1);
2374                 check_spends!(node_txn[0], chan_1.3);
2375                 assert_eq!(node_txn[1].input.len(), 1);
2376                 let witness_script = node_txn[1].input[0].witness.last().unwrap();
2377                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2378                 check_spends!(node_txn[1], node_txn[0]);
2379
2380                 // Justice transactions are indices 2-3-4
2381                 assert_eq!(node_txn[2].input.len(), 1);
2382                 assert_eq!(node_txn[3].input.len(), 1);
2383                 assert_eq!(node_txn[4].input.len(), 1);
2384                 check_spends!(node_txn[2], revoked_local_txn[0]);
2385                 check_spends!(node_txn[3], revoked_local_txn[0]);
2386                 check_spends!(node_txn[4], revoked_local_txn[0]);
2387
2388                 let mut witness_lens = BTreeSet::new();
2389                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2390                 witness_lens.insert(node_txn[3].input[0].witness.last().unwrap().len());
2391                 witness_lens.insert(node_txn[4].input[0].witness.last().unwrap().len());
2392                 assert_eq!(witness_lens.len(), 3);
2393                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2394                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2395                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2396         }
2397         get_announce_close_broadcast_events(&nodes, 0, 1);
2398         assert_eq!(nodes[0].node.list_channels().len(), 0);
2399         assert_eq!(nodes[1].node.list_channels().len(), 0);
2400 }
2401
2402 #[test]
2403 fn test_htlc_on_chain_success() {
2404         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2405         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2406         // broadcasting the right event to other nodes in payment path.
2407         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2408         // A --------------------> B ----------------------> C (preimage)
2409         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2410         // commitment transaction was broadcast.
2411         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2412         // towards B.
2413         // B should be able to claim via preimage if A then broadcasts its local tx.
2414         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2415         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2416         // PaymentSent event).
2417
2418         let chanmon_cfgs = create_chanmon_cfgs(3);
2419         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2420         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2421         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2422
2423         // Create some initial channels
2424         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2425         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2426
2427         // Rebalance the network a bit by relaying one payment through all the channels...
2428         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2429         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2430
2431         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2432         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2433         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2434
2435         // Broadcast legit commitment tx from C on B's chain
2436         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2437         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2438         assert_eq!(commitment_tx.len(), 1);
2439         check_spends!(commitment_tx[0], chan_2.3);
2440         nodes[2].node.claim_funds(our_payment_preimage, 3_000_000);
2441         nodes[2].node.claim_funds(our_payment_preimage_2, 3_000_000);
2442         check_added_monitors!(nodes[2], 2);
2443         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2444         assert!(updates.update_add_htlcs.is_empty());
2445         assert!(updates.update_fail_htlcs.is_empty());
2446         assert!(updates.update_fail_malformed_htlcs.is_empty());
2447         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2448
2449         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2450         check_closed_broadcast!(nodes[2], false);
2451         check_added_monitors!(nodes[2], 1);
2452         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx, 2*htlc-success tx), ChannelMonitor : 4 (2*2 * HTLC-Success tx)
2453         assert_eq!(node_txn.len(), 7);
2454         assert_eq!(node_txn[0], node_txn[3]);
2455         assert_eq!(node_txn[1], node_txn[4]);
2456         assert_eq!(node_txn[0], node_txn[5]);
2457         assert_eq!(node_txn[1], node_txn[6]);
2458         assert_eq!(node_txn[2], commitment_tx[0]);
2459         check_spends!(node_txn[0], commitment_tx[0]);
2460         check_spends!(node_txn[1], commitment_tx[0]);
2461         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2462         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2463         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2464         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2465         assert_eq!(node_txn[0].lock_time, 0);
2466         assert_eq!(node_txn[1].lock_time, 0);
2467
2468         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2469         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2470         {
2471                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2472                 assert_eq!(added_monitors.len(), 1);
2473                 assert_eq!(added_monitors[0].0.txid, chan_2.3.txid());
2474                 added_monitors.clear();
2475         }
2476         let events = nodes[1].node.get_and_clear_pending_msg_events();
2477         {
2478                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2479                 assert_eq!(added_monitors.len(), 2);
2480                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2481                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2482                 added_monitors.clear();
2483         }
2484         assert_eq!(events.len(), 2);
2485         match events[0] {
2486                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2487                 _ => panic!("Unexpected event"),
2488         }
2489         match events[1] {
2490                 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, .. } } => {
2491                         assert!(update_add_htlcs.is_empty());
2492                         assert!(update_fail_htlcs.is_empty());
2493                         assert_eq!(update_fulfill_htlcs.len(), 1);
2494                         assert!(update_fail_malformed_htlcs.is_empty());
2495                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2496                 },
2497                 _ => panic!("Unexpected event"),
2498         };
2499         macro_rules! check_tx_local_broadcast {
2500                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2501                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2502                         assert_eq!(node_txn.len(), if $htlc_offered { 7 } else { 5 });
2503                         // Node[1]: ChannelManager: 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 (timeout tx)
2504                         // Node[0]: ChannelManager: 3 (commtiemtn tx, 2*HTLC-Timeout tx), ChannelMonitor: 2 HTLC-timeout * 2 (block-rescan)
2505                         check_spends!(node_txn[0], $commitment_tx);
2506                         check_spends!(node_txn[1], $commitment_tx);
2507                         if $htlc_offered {
2508                                 assert_eq!(node_txn[0], node_txn[5]);
2509                                 assert_eq!(node_txn[1], node_txn[6]);
2510                         }
2511                         assert_ne!(node_txn[0].lock_time, 0);
2512                         assert_ne!(node_txn[1].lock_time, 0);
2513                         if $htlc_offered {
2514                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2515                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2516                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2517                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2518                         } else {
2519                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2520                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2521                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2522                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2523                         }
2524                         check_spends!(node_txn[2], $chan_tx);
2525                         check_spends!(node_txn[3], node_txn[2]);
2526                         check_spends!(node_txn[4], node_txn[2]);
2527                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2528                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2529                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2530                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2531                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2532                         assert_ne!(node_txn[3].lock_time, 0);
2533                         assert_ne!(node_txn[4].lock_time, 0);
2534                         node_txn.clear();
2535                 } }
2536         }
2537         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2538         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2539         // timeout-claim of the output that nodes[2] just claimed via success.
2540         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2541
2542         // Broadcast legit commitment tx from A on B's chain
2543         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2544         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
2545         check_spends!(commitment_tx[0], chan_1.3);
2546         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2547         check_closed_broadcast!(nodes[1], false);
2548         check_added_monitors!(nodes[1], 1);
2549         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 3 (commitment tx + HTLC-Sucess * 2), ChannelMonitor : 1 (HTLC-Success)
2550         assert_eq!(node_txn.len(), 4);
2551         check_spends!(node_txn[0], commitment_tx[0]);
2552         assert_eq!(node_txn[0].input.len(), 2);
2553         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2554         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2555         assert_eq!(node_txn[0].lock_time, 0);
2556         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2557         check_spends!(node_txn[1], chan_1.3);
2558         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2559         check_spends!(node_txn[2], node_txn[1]);
2560         check_spends!(node_txn[3], node_txn[1]);
2561         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2562         // we already checked the same situation with A.
2563
2564         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2565         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2566         check_closed_broadcast!(nodes[0], false);
2567         check_added_monitors!(nodes[0], 1);
2568         let events = nodes[0].node.get_and_clear_pending_events();
2569         assert_eq!(events.len(), 2);
2570         let mut first_claimed = false;
2571         for event in events {
2572                 match event {
2573                         Event::PaymentSent { payment_preimage } => {
2574                                 if payment_preimage == our_payment_preimage {
2575                                         assert!(!first_claimed);
2576                                         first_claimed = true;
2577                                 } else {
2578                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2579                                 }
2580                         },
2581                         _ => panic!("Unexpected event"),
2582                 }
2583         }
2584         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2585 }
2586
2587 #[test]
2588 fn test_htlc_on_chain_timeout() {
2589         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2590         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2591         // broadcasting the right event to other nodes in payment path.
2592         // A ------------------> B ----------------------> C (timeout)
2593         //    B's commitment tx                 C's commitment tx
2594         //            \                                  \
2595         //         B's HTLC timeout tx               B's timeout tx
2596
2597         let chanmon_cfgs = create_chanmon_cfgs(3);
2598         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2599         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2600         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2601
2602         // Create some intial channels
2603         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2604         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2605
2606         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2607         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2608         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2609
2610         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2611         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2612
2613         // Broadcast legit commitment tx from C on B's chain
2614         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
2615         check_spends!(commitment_tx[0], chan_2.3);
2616         nodes[2].node.fail_htlc_backwards(&payment_hash);
2617         check_added_monitors!(nodes[2], 0);
2618         expect_pending_htlcs_forwardable!(nodes[2]);
2619         check_added_monitors!(nodes[2], 1);
2620
2621         let events = nodes[2].node.get_and_clear_pending_msg_events();
2622         assert_eq!(events.len(), 1);
2623         match events[0] {
2624                 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, .. } } => {
2625                         assert!(update_add_htlcs.is_empty());
2626                         assert!(!update_fail_htlcs.is_empty());
2627                         assert!(update_fulfill_htlcs.is_empty());
2628                         assert!(update_fail_malformed_htlcs.is_empty());
2629                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2630                 },
2631                 _ => panic!("Unexpected event"),
2632         };
2633         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2634         check_closed_broadcast!(nodes[2], false);
2635         check_added_monitors!(nodes[2], 1);
2636         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2637         assert_eq!(node_txn.len(), 1);
2638         check_spends!(node_txn[0], chan_2.3);
2639         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2640
2641         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2642         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2643         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2644         let timeout_tx;
2645         {
2646                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2647                 assert_eq!(node_txn.len(), 7); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : (local commitment tx + HTLC-timeout) * 2 (block-rescan), timeout tx
2648                 assert_eq!(node_txn[0], node_txn[3]);
2649                 assert_eq!(node_txn[0], node_txn[5]);
2650                 assert_eq!(node_txn[1], node_txn[4]);
2651                 assert_eq!(node_txn[1], node_txn[6]);
2652
2653                 check_spends!(node_txn[2], commitment_tx[0]);
2654                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2655
2656                 check_spends!(node_txn[0], chan_2.3);
2657                 check_spends!(node_txn[1], node_txn[0]);
2658                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), 71);
2659                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2660
2661                 timeout_tx = node_txn[2].clone();
2662                 node_txn.clear();
2663         }
2664
2665         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2666         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2667         check_added_monitors!(nodes[1], 1);
2668         check_closed_broadcast!(nodes[1], false);
2669
2670         expect_pending_htlcs_forwardable!(nodes[1]);
2671         check_added_monitors!(nodes[1], 1);
2672         let events = nodes[1].node.get_and_clear_pending_msg_events();
2673         assert_eq!(events.len(), 1);
2674         match events[0] {
2675                 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, .. } } => {
2676                         assert!(update_add_htlcs.is_empty());
2677                         assert!(!update_fail_htlcs.is_empty());
2678                         assert!(update_fulfill_htlcs.is_empty());
2679                         assert!(update_fail_malformed_htlcs.is_empty());
2680                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2681                 },
2682                 _ => panic!("Unexpected event"),
2683         };
2684         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
2685         assert_eq!(node_txn.len(), 0);
2686
2687         // Broadcast legit commitment tx from B on A's chain
2688         let commitment_tx = get_local_commitment_txn!(nodes[1], chan_1.2);
2689         check_spends!(commitment_tx[0], chan_1.3);
2690
2691         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2692         check_closed_broadcast!(nodes[0], false);
2693         check_added_monitors!(nodes[0], 1);
2694         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 1 timeout tx
2695         assert_eq!(node_txn.len(), 3);
2696         check_spends!(node_txn[0], commitment_tx[0]);
2697         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2698         check_spends!(node_txn[1], chan_1.3);
2699         check_spends!(node_txn[2], node_txn[1]);
2700         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2701         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2702 }
2703
2704 #[test]
2705 fn test_simple_commitment_revoked_fail_backward() {
2706         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2707         // and fail backward accordingly.
2708
2709         let chanmon_cfgs = create_chanmon_cfgs(3);
2710         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2711         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2712         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2713
2714         // Create some initial channels
2715         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2716         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2717
2718         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2719         // Get the will-be-revoked local txn from nodes[2]
2720         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2721         // Revoke the old state
2722         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2723
2724         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2725
2726         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2727         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2728         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2729         check_added_monitors!(nodes[1], 1);
2730         check_closed_broadcast!(nodes[1], false);
2731
2732         expect_pending_htlcs_forwardable!(nodes[1]);
2733         check_added_monitors!(nodes[1], 1);
2734         let events = nodes[1].node.get_and_clear_pending_msg_events();
2735         assert_eq!(events.len(), 1);
2736         match events[0] {
2737                 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, .. } } => {
2738                         assert!(update_add_htlcs.is_empty());
2739                         assert_eq!(update_fail_htlcs.len(), 1);
2740                         assert!(update_fulfill_htlcs.is_empty());
2741                         assert!(update_fail_malformed_htlcs.is_empty());
2742                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2743
2744                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2745                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2746
2747                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2748                         assert_eq!(events.len(), 1);
2749                         match events[0] {
2750                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2751                                 _ => panic!("Unexpected event"),
2752                         }
2753                         let events = nodes[0].node.get_and_clear_pending_events();
2754                         assert_eq!(events.len(), 1);
2755                         match events[0] {
2756                                 Event::PaymentFailed { .. } => {},
2757                                 _ => panic!("Unexpected event"),
2758                         }
2759                 },
2760                 _ => panic!("Unexpected event"),
2761         }
2762 }
2763
2764 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2765         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2766         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2767         // commitment transaction anymore.
2768         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2769         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2770         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2771         // technically disallowed and we should probably handle it reasonably.
2772         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2773         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2774         // transactions:
2775         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2776         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2777         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2778         //   and once they revoke the previous commitment transaction (allowing us to send a new
2779         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2780         let chanmon_cfgs = create_chanmon_cfgs(3);
2781         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
2782         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
2783         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
2784
2785         // Create some initial channels
2786         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
2787         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
2788
2789         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2790         // Get the will-be-revoked local txn from nodes[2]
2791         let revoked_local_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
2792         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2793         // Revoke the old state
2794         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2795
2796         let value = if use_dust {
2797                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2798                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2799                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2800         } else { 3000000 };
2801
2802         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2803         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2804         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2805
2806         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2807         expect_pending_htlcs_forwardable!(nodes[2]);
2808         check_added_monitors!(nodes[2], 1);
2809         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2810         assert!(updates.update_add_htlcs.is_empty());
2811         assert!(updates.update_fulfill_htlcs.is_empty());
2812         assert!(updates.update_fail_malformed_htlcs.is_empty());
2813         assert_eq!(updates.update_fail_htlcs.len(), 1);
2814         assert!(updates.update_fee.is_none());
2815         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2816         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2817         // Drop the last RAA from 3 -> 2
2818
2819         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2820         expect_pending_htlcs_forwardable!(nodes[2]);
2821         check_added_monitors!(nodes[2], 1);
2822         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2823         assert!(updates.update_add_htlcs.is_empty());
2824         assert!(updates.update_fulfill_htlcs.is_empty());
2825         assert!(updates.update_fail_malformed_htlcs.is_empty());
2826         assert_eq!(updates.update_fail_htlcs.len(), 1);
2827         assert!(updates.update_fee.is_none());
2828         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2829         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2830         check_added_monitors!(nodes[1], 1);
2831         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2832         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2833         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2834         check_added_monitors!(nodes[2], 1);
2835
2836         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2837         expect_pending_htlcs_forwardable!(nodes[2]);
2838         check_added_monitors!(nodes[2], 1);
2839         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2840         assert!(updates.update_add_htlcs.is_empty());
2841         assert!(updates.update_fulfill_htlcs.is_empty());
2842         assert!(updates.update_fail_malformed_htlcs.is_empty());
2843         assert_eq!(updates.update_fail_htlcs.len(), 1);
2844         assert!(updates.update_fee.is_none());
2845         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
2846         // At this point first_payment_hash has dropped out of the latest two commitment
2847         // transactions that nodes[1] is tracking...
2848         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed);
2849         check_added_monitors!(nodes[1], 1);
2850         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2851         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2852         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa);
2853         check_added_monitors!(nodes[2], 1);
2854
2855         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2856         // on nodes[2]'s RAA.
2857         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2858         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2859         nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2860         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2861         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2862         check_added_monitors!(nodes[1], 0);
2863
2864         if deliver_bs_raa {
2865                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa);
2866                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2867                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2868                 check_added_monitors!(nodes[1], 1);
2869                 let events = nodes[1].node.get_and_clear_pending_events();
2870                 assert_eq!(events.len(), 1);
2871                 match events[0] {
2872                         Event::PendingHTLCsForwardable { .. } => { },
2873                         _ => panic!("Unexpected event"),
2874                 };
2875                 // Deliberately don't process the pending fail-back so they all fail back at once after
2876                 // block connection just like the !deliver_bs_raa case
2877         }
2878
2879         let mut failed_htlcs = HashSet::new();
2880         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2881
2882         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2883         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2884         check_added_monitors!(nodes[1], 1);
2885         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2886
2887         let events = nodes[1].node.get_and_clear_pending_events();
2888         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2889         match events[0] {
2890                 Event::PaymentFailed { ref payment_hash, .. } => {
2891                         assert_eq!(*payment_hash, fourth_payment_hash);
2892                 },
2893                 _ => panic!("Unexpected event"),
2894         }
2895         if !deliver_bs_raa {
2896                 match events[1] {
2897                         Event::PendingHTLCsForwardable { .. } => { },
2898                         _ => panic!("Unexpected event"),
2899                 };
2900         }
2901         nodes[1].node.process_pending_htlc_forwards();
2902         check_added_monitors!(nodes[1], 1);
2903
2904         let events = nodes[1].node.get_and_clear_pending_msg_events();
2905         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2906         match events[if deliver_bs_raa { 1 } else { 0 }] {
2907                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2908                 _ => panic!("Unexpected event"),
2909         }
2910         if deliver_bs_raa {
2911                 match events[0] {
2912                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, ref update_fulfill_htlcs, ref update_fail_malformed_htlcs, .. } } => {
2913                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2914                                 assert_eq!(update_add_htlcs.len(), 1);
2915                                 assert!(update_fulfill_htlcs.is_empty());
2916                                 assert!(update_fail_htlcs.is_empty());
2917                                 assert!(update_fail_malformed_htlcs.is_empty());
2918                         },
2919                         _ => panic!("Unexpected event"),
2920                 }
2921         }
2922         match events[if deliver_bs_raa { 2 } else { 1 }] {
2923                 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, .. } } => {
2924                         assert!(update_add_htlcs.is_empty());
2925                         assert_eq!(update_fail_htlcs.len(), 3);
2926                         assert!(update_fulfill_htlcs.is_empty());
2927                         assert!(update_fail_malformed_htlcs.is_empty());
2928                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2929
2930                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]);
2931                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]);
2932                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]);
2933
2934                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2935
2936                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2937                         // If we delivered B's RAA we got an unknown preimage error, not something
2938                         // that we should update our routing table for.
2939                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2940                         for event in events {
2941                                 match event {
2942                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2943                                         _ => panic!("Unexpected event"),
2944                                 }
2945                         }
2946                         let events = nodes[0].node.get_and_clear_pending_events();
2947                         assert_eq!(events.len(), 3);
2948                         match events[0] {
2949                                 Event::PaymentFailed { ref payment_hash, .. } => {
2950                                         assert!(failed_htlcs.insert(payment_hash.0));
2951                                 },
2952                                 _ => panic!("Unexpected event"),
2953                         }
2954                         match events[1] {
2955                                 Event::PaymentFailed { ref payment_hash, .. } => {
2956                                         assert!(failed_htlcs.insert(payment_hash.0));
2957                                 },
2958                                 _ => panic!("Unexpected event"),
2959                         }
2960                         match events[2] {
2961                                 Event::PaymentFailed { ref payment_hash, .. } => {
2962                                         assert!(failed_htlcs.insert(payment_hash.0));
2963                                 },
2964                                 _ => panic!("Unexpected event"),
2965                         }
2966                 },
2967                 _ => panic!("Unexpected event"),
2968         }
2969
2970         assert!(failed_htlcs.contains(&first_payment_hash.0));
2971         assert!(failed_htlcs.contains(&second_payment_hash.0));
2972         assert!(failed_htlcs.contains(&third_payment_hash.0));
2973 }
2974
2975 #[test]
2976 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2977         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2978         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2979         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2980         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2981 }
2982
2983 #[test]
2984 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2985         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2986         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2987         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2988         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2989 }
2990
2991 #[test]
2992 fn fail_backward_pending_htlc_upon_channel_failure() {
2993         let chanmon_cfgs = create_chanmon_cfgs(2);
2994         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
2995         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
2996         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
2997         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1_000_000, 500_000_000, InitFeatures::supported(), InitFeatures::supported());
2998
2999         // Alice -> Bob: Route a payment but without Bob sending revoke_and_ack.
3000         {
3001                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
3002                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
3003                 nodes[0].node.send_payment(route, payment_hash).unwrap();
3004                 check_added_monitors!(nodes[0], 1);
3005
3006                 let payment_event = {
3007                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3008                         assert_eq!(events.len(), 1);
3009                         SendEvent::from_event(events.remove(0))
3010                 };
3011                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
3012                 assert_eq!(payment_event.msgs.len(), 1);
3013         }
3014
3015         // Alice -> Bob: Route another payment but now Alice waits for Bob's earlier revoke_and_ack.
3016         let (_, failed_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3017         {
3018                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
3019                 nodes[0].node.send_payment(route, failed_payment_hash).unwrap();
3020                 check_added_monitors!(nodes[0], 0);
3021
3022                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3023         }
3024
3025         // Alice <- Bob: Send a malformed update_add_htlc so Alice fails the channel.
3026         {
3027                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 50_000, TEST_FINAL_CLTV).unwrap();
3028                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[1]);
3029
3030                 let secp_ctx = Secp256k1::new();
3031                 let session_priv = {
3032                         let mut session_key = [0; 32];
3033                         let mut rng = thread_rng();
3034                         rng.fill_bytes(&mut session_key);
3035                         SecretKey::from_slice(&session_key).expect("RNG is bad!")
3036                 };
3037
3038                 let current_height = nodes[1].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
3039                 let (onion_payloads, _amount_msat, cltv_expiry) = onion_utils::build_onion_payloads(&route, current_height).unwrap();
3040                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
3041                 let onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
3042
3043                 // Send a 0-msat update_add_htlc to fail the channel.
3044                 let update_add_htlc = msgs::UpdateAddHTLC {
3045                         channel_id: chan.2,
3046                         htlc_id: 0,
3047                         amount_msat: 0,
3048                         payment_hash,
3049                         cltv_expiry,
3050                         onion_routing_packet,
3051                 };
3052                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_htlc);
3053         }
3054
3055         // Check that Alice fails backward the pending HTLC from the second payment.
3056         expect_payment_failed!(nodes[0], failed_payment_hash, true);
3057         check_closed_broadcast!(nodes[0], true);
3058         check_added_monitors!(nodes[0], 1);
3059 }
3060
3061 #[test]
3062 fn test_htlc_ignore_latest_remote_commitment() {
3063         // Test that HTLC transactions spending the latest remote commitment transaction are simply
3064         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
3065         let chanmon_cfgs = create_chanmon_cfgs(2);
3066         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3067         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3068         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3069         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3070
3071         route_payment(&nodes[0], &[&nodes[1]], 10000000);
3072         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
3073         check_closed_broadcast!(nodes[0], false);
3074         check_added_monitors!(nodes[0], 1);
3075
3076         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3077         assert_eq!(node_txn.len(), 2);
3078
3079         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3080         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3081         check_closed_broadcast!(nodes[1], false);
3082         check_added_monitors!(nodes[1], 1);
3083
3084         // Duplicate the block_connected call since this may happen due to other listeners
3085         // registering new transactions
3086         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
3087 }
3088
3089 #[test]
3090 fn test_force_close_fail_back() {
3091         // Check which HTLCs are failed-backwards on channel force-closure
3092         let chanmon_cfgs = create_chanmon_cfgs(3);
3093         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3094         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3095         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3096         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3097         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3098
3099         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
3100
3101         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3102
3103         let mut payment_event = {
3104                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
3105                 check_added_monitors!(nodes[0], 1);
3106
3107                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3108                 assert_eq!(events.len(), 1);
3109                 SendEvent::from_event(events.remove(0))
3110         };
3111
3112         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3113         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
3114
3115         expect_pending_htlcs_forwardable!(nodes[1]);
3116
3117         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3118         assert_eq!(events_2.len(), 1);
3119         payment_event = SendEvent::from_event(events_2.remove(0));
3120         assert_eq!(payment_event.msgs.len(), 1);
3121
3122         check_added_monitors!(nodes[1], 1);
3123         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
3124         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg);
3125         check_added_monitors!(nodes[2], 1);
3126         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3127
3128         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
3129         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
3130         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
3131
3132         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
3133         check_closed_broadcast!(nodes[2], false);
3134         check_added_monitors!(nodes[2], 1);
3135         let tx = {
3136                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3137                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
3138                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
3139                 // back to nodes[1] upon timeout otherwise.
3140                 assert_eq!(node_txn.len(), 1);
3141                 node_txn.remove(0)
3142         };
3143
3144         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3145         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3146
3147         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
3148         check_closed_broadcast!(nodes[1], false);
3149         check_added_monitors!(nodes[1], 1);
3150
3151         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
3152         {
3153                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
3154                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
3155                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
3156         }
3157         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
3158         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
3159         assert_eq!(node_txn.len(), 1);
3160         assert_eq!(node_txn[0].input.len(), 1);
3161         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
3162         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
3163         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
3164
3165         check_spends!(node_txn[0], tx);
3166 }
3167
3168 #[test]
3169 fn test_unconf_chan() {
3170         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3171         let chanmon_cfgs = create_chanmon_cfgs(2);
3172         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3173         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3174         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3175         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3176
3177         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3178         assert_eq!(channel_state.by_id.len(), 1);
3179         assert_eq!(channel_state.short_to_id.len(), 1);
3180         mem::drop(channel_state);
3181
3182         let mut headers = Vec::new();
3183         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3184         headers.push(header.clone());
3185         for _i in 2..100 {
3186                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3187                 headers.push(header.clone());
3188         }
3189         let mut height = 99;
3190         while !headers.is_empty() {
3191                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
3192                 height -= 1;
3193         }
3194         check_closed_broadcast!(nodes[0], false);
3195         check_added_monitors!(nodes[0], 1);
3196         let channel_state = nodes[0].node.channel_state.lock().unwrap();
3197         assert_eq!(channel_state.by_id.len(), 0);
3198         assert_eq!(channel_state.short_to_id.len(), 0);
3199 }
3200
3201 #[test]
3202 fn test_simple_peer_disconnect() {
3203         // Test that we can reconnect when there are no lost messages
3204         let chanmon_cfgs = create_chanmon_cfgs(3);
3205         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
3206         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
3207         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
3208         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3209         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
3210
3211         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3212         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3213         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3214
3215         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3216         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3217         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
3218         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
3219
3220         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3221         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3222         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3223
3224         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3225         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
3226         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3227         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
3228
3229         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3230         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3231
3232         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
3233         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
3234
3235         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
3236         {
3237                 let events = nodes[0].node.get_and_clear_pending_events();
3238                 assert_eq!(events.len(), 2);
3239                 match events[0] {
3240                         Event::PaymentSent { payment_preimage } => {
3241                                 assert_eq!(payment_preimage, payment_preimage_3);
3242                         },
3243                         _ => panic!("Unexpected event"),
3244                 }
3245                 match events[1] {
3246                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
3247                                 assert_eq!(payment_hash, payment_hash_5);
3248                                 assert!(rejected_by_dest);
3249                         },
3250                         _ => panic!("Unexpected event"),
3251                 }
3252         }
3253
3254         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
3255         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
3256 }
3257
3258 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
3259         // Test that we can reconnect when in-flight HTLC updates get dropped
3260         let chanmon_cfgs = create_chanmon_cfgs(2);
3261         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3262         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3263         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3264         if messages_delivered == 0 {
3265                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3266                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
3267         } else {
3268                 create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3269         }
3270
3271         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();
3272         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
3273
3274         let payment_event = {
3275                 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
3276                 check_added_monitors!(nodes[0], 1);
3277
3278                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
3279                 assert_eq!(events.len(), 1);
3280                 SendEvent::from_event(events.remove(0))
3281         };
3282         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
3283
3284         if messages_delivered < 2 {
3285                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
3286         } else {
3287                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
3288                 if messages_delivered >= 3 {
3289                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg);
3290                         check_added_monitors!(nodes[1], 1);
3291                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3292
3293                         if messages_delivered >= 4 {
3294                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3295                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3296                                 check_added_monitors!(nodes[0], 1);
3297
3298                                 if messages_delivered >= 5 {
3299                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed);
3300                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3301                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3302                                         check_added_monitors!(nodes[0], 1);
3303
3304                                         if messages_delivered >= 6 {
3305                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3306                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3307                                                 check_added_monitors!(nodes[1], 1);
3308                                         }
3309                                 }
3310                         }
3311                 }
3312         }
3313
3314         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3315         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3316         if messages_delivered < 3 {
3317                 // Even if the funding_locked messages get exchanged, as long as nothing further was
3318                 // received on either side, both sides will need to resend them.
3319                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
3320         } else if messages_delivered == 3 {
3321                 // nodes[0] still wants its RAA + commitment_signed
3322                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
3323         } else if messages_delivered == 4 {
3324                 // nodes[0] still wants its commitment_signed
3325                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
3326         } else if messages_delivered == 5 {
3327                 // nodes[1] still wants its final RAA
3328                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
3329         } else if messages_delivered == 6 {
3330                 // Everything was delivered...
3331                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3332         }
3333
3334         let events_1 = nodes[1].node.get_and_clear_pending_events();
3335         assert_eq!(events_1.len(), 1);
3336         match events_1[0] {
3337                 Event::PendingHTLCsForwardable { .. } => { },
3338                 _ => panic!("Unexpected event"),
3339         };
3340
3341         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3342         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3343         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3344
3345         nodes[1].node.process_pending_htlc_forwards();
3346
3347         let events_2 = nodes[1].node.get_and_clear_pending_events();
3348         assert_eq!(events_2.len(), 1);
3349         match events_2[0] {
3350                 Event::PaymentReceived { ref payment_hash, amt } => {
3351                         assert_eq!(payment_hash_1, *payment_hash);
3352                         assert_eq!(amt, 1000000);
3353                 },
3354                 _ => panic!("Unexpected event"),
3355         }
3356
3357         nodes[1].node.claim_funds(payment_preimage_1, 1_000_000);
3358         check_added_monitors!(nodes[1], 1);
3359
3360         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
3361         assert_eq!(events_3.len(), 1);
3362         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
3363                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3364                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3365                         assert!(updates.update_add_htlcs.is_empty());
3366                         assert!(updates.update_fail_htlcs.is_empty());
3367                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3368                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3369                         assert!(updates.update_fee.is_none());
3370                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
3371                 },
3372                 _ => panic!("Unexpected event"),
3373         };
3374
3375         if messages_delivered >= 1 {
3376                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc);
3377
3378                 let events_4 = nodes[0].node.get_and_clear_pending_events();
3379                 assert_eq!(events_4.len(), 1);
3380                 match events_4[0] {
3381                         Event::PaymentSent { ref payment_preimage } => {
3382                                 assert_eq!(payment_preimage_1, *payment_preimage);
3383                         },
3384                         _ => panic!("Unexpected event"),
3385                 }
3386
3387                 if messages_delivered >= 2 {
3388                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed);
3389                         check_added_monitors!(nodes[0], 1);
3390                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3391
3392                         if messages_delivered >= 3 {
3393                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3394                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3395                                 check_added_monitors!(nodes[1], 1);
3396
3397                                 if messages_delivered >= 4 {
3398                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed);
3399                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3400                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3401                                         check_added_monitors!(nodes[1], 1);
3402
3403                                         if messages_delivered >= 5 {
3404                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3405                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3406                                                 check_added_monitors!(nodes[0], 1);
3407                                         }
3408                                 }
3409                         }
3410                 }
3411         }
3412
3413         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3414         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3415         if messages_delivered < 2 {
3416                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3417                 //TODO: Deduplicate PaymentSent events, then enable this if:
3418                 //if messages_delivered < 1 {
3419                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3420                         assert_eq!(events_4.len(), 1);
3421                         match events_4[0] {
3422                                 Event::PaymentSent { ref payment_preimage } => {
3423                                         assert_eq!(payment_preimage_1, *payment_preimage);
3424                                 },
3425                                 _ => panic!("Unexpected event"),
3426                         }
3427                 //}
3428         } else if messages_delivered == 2 {
3429                 // nodes[0] still wants its RAA + commitment_signed
3430                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3431         } else if messages_delivered == 3 {
3432                 // nodes[0] still wants its commitment_signed
3433                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3434         } else if messages_delivered == 4 {
3435                 // nodes[1] still wants its final RAA
3436                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3437         } else if messages_delivered == 5 {
3438                 // Everything was delivered...
3439                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3440         }
3441
3442         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3443         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3444         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3445
3446         // Channel should still work fine...
3447         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3448         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3449 }
3450
3451 #[test]
3452 fn test_drop_messages_peer_disconnect_a() {
3453         do_test_drop_messages_peer_disconnect(0);
3454         do_test_drop_messages_peer_disconnect(1);
3455         do_test_drop_messages_peer_disconnect(2);
3456         do_test_drop_messages_peer_disconnect(3);
3457 }
3458
3459 #[test]
3460 fn test_drop_messages_peer_disconnect_b() {
3461         do_test_drop_messages_peer_disconnect(4);
3462         do_test_drop_messages_peer_disconnect(5);
3463         do_test_drop_messages_peer_disconnect(6);
3464 }
3465
3466 #[test]
3467 fn test_funding_peer_disconnect() {
3468         // Test that we can lock in our funding tx while disconnected
3469         let chanmon_cfgs = create_chanmon_cfgs(2);
3470         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3471         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3472         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3473         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3474
3475         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3476         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3477
3478         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3479         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3480         assert_eq!(events_1.len(), 1);
3481         match events_1[0] {
3482                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3483                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3484                 },
3485                 _ => panic!("Unexpected event"),
3486         }
3487
3488         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3489
3490         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3491         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3492
3493         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3494         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3495         assert_eq!(events_2.len(), 2);
3496         let funding_locked = match events_2[0] {
3497                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3498                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3499                         msg.clone()
3500                 },
3501                 _ => panic!("Unexpected event"),
3502         };
3503         let bs_announcement_sigs = match events_2[1] {
3504                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3505                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3506                         msg.clone()
3507                 },
3508                 _ => panic!("Unexpected event"),
3509         };
3510
3511         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3512
3513         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked);
3514         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs);
3515         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3516         assert_eq!(events_3.len(), 2);
3517         let as_announcement_sigs = match events_3[0] {
3518                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3519                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3520                         msg.clone()
3521                 },
3522                 _ => panic!("Unexpected event"),
3523         };
3524         let (as_announcement, as_update) = match events_3[1] {
3525                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3526                         (msg.clone(), update_msg.clone())
3527                 },
3528                 _ => panic!("Unexpected event"),
3529         };
3530
3531         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs);
3532         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3533         assert_eq!(events_4.len(), 1);
3534         let (_, bs_update) = match events_4[0] {
3535                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3536                         (msg.clone(), update_msg.clone())
3537                 },
3538                 _ => panic!("Unexpected event"),
3539         };
3540
3541         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3542         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3543         nodes[0].router.handle_channel_update(&as_update).unwrap();
3544
3545         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3546         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3547         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3548 }
3549
3550 #[test]
3551 fn test_drop_messages_peer_disconnect_dual_htlc() {
3552         // Test that we can handle reconnecting when both sides of a channel have pending
3553         // commitment_updates when we disconnect.
3554         let chanmon_cfgs = create_chanmon_cfgs(2);
3555         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3556         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3557         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3558         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3559
3560         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3561
3562         // Now try to send a second payment which will fail to send
3563         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3564         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3565
3566         nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3567         check_added_monitors!(nodes[0], 1);
3568
3569         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3570         assert_eq!(events_1.len(), 1);
3571         match events_1[0] {
3572                 MessageSendEvent::UpdateHTLCs { .. } => {},
3573                 _ => panic!("Unexpected event"),
3574         }
3575
3576         assert!(nodes[1].node.claim_funds(payment_preimage_1, 1_000_000));
3577         check_added_monitors!(nodes[1], 1);
3578
3579         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3580         assert_eq!(events_2.len(), 1);
3581         match events_2[0] {
3582                 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 } } => {
3583                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3584                         assert!(update_add_htlcs.is_empty());
3585                         assert_eq!(update_fulfill_htlcs.len(), 1);
3586                         assert!(update_fail_htlcs.is_empty());
3587                         assert!(update_fail_malformed_htlcs.is_empty());
3588                         assert!(update_fee.is_none());
3589
3590                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]);
3591                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3592                         assert_eq!(events_3.len(), 1);
3593                         match events_3[0] {
3594                                 Event::PaymentSent { ref payment_preimage } => {
3595                                         assert_eq!(*payment_preimage, payment_preimage_1);
3596                                 },
3597                                 _ => panic!("Unexpected event"),
3598                         }
3599
3600                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed);
3601                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3602                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3603                         check_added_monitors!(nodes[0], 1);
3604                 },
3605                 _ => panic!("Unexpected event"),
3606         }
3607
3608         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3609         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3610
3611         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3612         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3613         assert_eq!(reestablish_1.len(), 1);
3614         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3615         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3616         assert_eq!(reestablish_2.len(), 1);
3617
3618         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3619         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3620         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3621         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3622
3623         assert!(as_resp.0.is_none());
3624         assert!(bs_resp.0.is_none());
3625
3626         assert!(bs_resp.1.is_none());
3627         assert!(bs_resp.2.is_none());
3628
3629         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3630
3631         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3632         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3633         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3634         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3635         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3636         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]);
3637         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed);
3638         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3639         // No commitment_signed so get_event_msg's assert(len == 1) passes
3640         check_added_monitors!(nodes[1], 1);
3641
3642         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap());
3643         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3644         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3645         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3646         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3647         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3648         assert!(bs_second_commitment_signed.update_fee.is_none());
3649         check_added_monitors!(nodes[1], 1);
3650
3651         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
3652         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3653         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3654         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3655         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3656         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3657         assert!(as_commitment_signed.update_fee.is_none());
3658         check_added_monitors!(nodes[0], 1);
3659
3660         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed);
3661         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3662         // No commitment_signed so get_event_msg's assert(len == 1) passes
3663         check_added_monitors!(nodes[0], 1);
3664
3665         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed);
3666         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3667         // No commitment_signed so get_event_msg's assert(len == 1) passes
3668         check_added_monitors!(nodes[1], 1);
3669
3670         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack);
3671         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3672         check_added_monitors!(nodes[1], 1);
3673
3674         expect_pending_htlcs_forwardable!(nodes[1]);
3675
3676         let events_5 = nodes[1].node.get_and_clear_pending_events();
3677         assert_eq!(events_5.len(), 1);
3678         match events_5[0] {
3679                 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3680                         assert_eq!(payment_hash_2, *payment_hash);
3681                 },
3682                 _ => panic!("Unexpected event"),
3683         }
3684
3685         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack);
3686         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3687         check_added_monitors!(nodes[0], 1);
3688
3689         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3690 }
3691
3692 #[test]
3693 fn test_invalid_channel_announcement() {
3694         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3695         let secp_ctx = Secp256k1::new();
3696         let chanmon_cfgs = create_chanmon_cfgs(2);
3697         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3698         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3699         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3700
3701         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], InitFeatures::supported(), InitFeatures::supported());
3702
3703         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3704         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3705         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3706         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3707
3708         nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
3709
3710         let as_bitcoin_key = as_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3711         let bs_bitcoin_key = bs_chan.get_local_keys().inner.local_channel_pubkeys.funding_pubkey;
3712
3713         let as_network_key = nodes[0].node.get_our_node_id();
3714         let bs_network_key = nodes[1].node.get_our_node_id();
3715
3716         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3717
3718         let mut chan_announcement;
3719
3720         macro_rules! dummy_unsigned_msg {
3721                 () => {
3722                         msgs::UnsignedChannelAnnouncement {
3723                                 features: ChannelFeatures::supported(),
3724                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3725                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3726                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3727                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3728                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3729                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3730                                 excess_data: Vec::new(),
3731                         };
3732                 }
3733         }
3734
3735         macro_rules! sign_msg {
3736                 ($unsigned_msg: expr) => {
3737                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3738                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().inner.funding_key());
3739                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().inner.funding_key());
3740                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3741                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3742                         chan_announcement = msgs::ChannelAnnouncement {
3743                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3744                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3745                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3746                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3747                                 contents: $unsigned_msg
3748                         }
3749                 }
3750         }
3751
3752         let unsigned_msg = dummy_unsigned_msg!();
3753         sign_msg!(unsigned_msg);
3754         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3755         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 } );
3756
3757         // Configured with Network::Testnet
3758         let mut unsigned_msg = dummy_unsigned_msg!();
3759         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3760         sign_msg!(unsigned_msg);
3761         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3762
3763         let mut unsigned_msg = dummy_unsigned_msg!();
3764         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3765         sign_msg!(unsigned_msg);
3766         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3767 }
3768
3769 #[test]
3770 fn test_no_txn_manager_serialize_deserialize() {
3771         let chanmon_cfgs = create_chanmon_cfgs(2);
3772         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3773         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3774         let fee_estimator: test_utils::TestFeeEstimator;
3775         let new_chan_monitor: test_utils::TestChannelMonitor;
3776         let keys_manager: test_utils::TestKeysInterface;
3777         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3778         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3779
3780         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, InitFeatures::supported(), InitFeatures::supported());
3781
3782         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3783
3784         let nodes_0_serialized = nodes[0].node.encode();
3785         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3786         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3787
3788         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3789         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);
3790         nodes[0].chan_monitor = &new_chan_monitor;
3791         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3792         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3793         assert!(chan_0_monitor_read.is_empty());
3794
3795         let mut nodes_0_read = &nodes_0_serialized[..];
3796         let config = UserConfig::default();
3797         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3798         let (_, nodes_0_deserialized_tmp) = {
3799                 let mut channel_monitors = HashMap::new();
3800                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3801                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3802                         default_config: config,
3803                         keys_manager: &keys_manager,
3804                         fee_estimator: &fee_estimator,
3805                         monitor: nodes[0].chan_monitor,
3806                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3807                         logger: Arc::new(test_utils::TestLogger::new()),
3808                         channel_monitors: &mut channel_monitors,
3809                 }).unwrap()
3810         };
3811         nodes_0_deserialized = nodes_0_deserialized_tmp;
3812         assert!(nodes_0_read.is_empty());
3813
3814         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3815         nodes[0].node = &nodes_0_deserialized;
3816         nodes[0].block_notifier.register_listener(nodes[0].node);
3817         assert_eq!(nodes[0].node.list_channels().len(), 1);
3818         check_added_monitors!(nodes[0], 1);
3819
3820         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3821         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3822         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3823         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3824
3825         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
3826         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3827         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
3828         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3829
3830         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3831         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3832         for node in nodes.iter() {
3833                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3834                 node.router.handle_channel_update(&as_update).unwrap();
3835                 node.router.handle_channel_update(&bs_update).unwrap();
3836         }
3837
3838         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3839 }
3840
3841 #[test]
3842 fn test_simple_manager_serialize_deserialize() {
3843         let chanmon_cfgs = create_chanmon_cfgs(2);
3844         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
3845         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
3846         let fee_estimator: test_utils::TestFeeEstimator;
3847         let new_chan_monitor: test_utils::TestChannelMonitor;
3848         let keys_manager: test_utils::TestKeysInterface;
3849         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3850         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
3851         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3852
3853         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3854         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3855
3856         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3857
3858         let nodes_0_serialized = nodes[0].node.encode();
3859         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3860         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3861
3862         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3863         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);
3864         nodes[0].chan_monitor = &new_chan_monitor;
3865         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3866         let (_, mut chan_0_monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3867         assert!(chan_0_monitor_read.is_empty());
3868
3869         let mut nodes_0_read = &nodes_0_serialized[..];
3870         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3871         let (_, nodes_0_deserialized_tmp) = {
3872                 let mut channel_monitors = HashMap::new();
3873                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &mut chan_0_monitor);
3874                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3875                         default_config: UserConfig::default(),
3876                         keys_manager: &keys_manager,
3877                         fee_estimator: &fee_estimator,
3878                         monitor: nodes[0].chan_monitor,
3879                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3880                         logger: Arc::new(test_utils::TestLogger::new()),
3881                         channel_monitors: &mut channel_monitors,
3882                 }).unwrap()
3883         };
3884         nodes_0_deserialized = nodes_0_deserialized_tmp;
3885         assert!(nodes_0_read.is_empty());
3886
3887         assert!(nodes[0].chan_monitor.add_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3888         nodes[0].node = &nodes_0_deserialized;
3889         check_added_monitors!(nodes[0], 1);
3890
3891         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3892
3893         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3894         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3895 }
3896
3897 #[test]
3898 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3899         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3900         let chanmon_cfgs = create_chanmon_cfgs(4);
3901         let node_cfgs = create_node_cfgs(4, &chanmon_cfgs);
3902         let node_chanmgrs = create_node_chanmgrs(4, &node_cfgs, &[None, None, None, None]);
3903         let fee_estimator: test_utils::TestFeeEstimator;
3904         let new_chan_monitor: test_utils::TestChannelMonitor;
3905         let keys_manager: test_utils::TestKeysInterface;
3906         let nodes_0_deserialized: ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>;
3907         let mut nodes = create_network(4, &node_cfgs, &node_chanmgrs);
3908         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
3909         create_announced_chan_between_nodes(&nodes, 2, 0, InitFeatures::supported(), InitFeatures::supported());
3910         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, InitFeatures::supported(), InitFeatures::supported());
3911
3912         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3913
3914         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3915         let nodes_0_serialized = nodes[0].node.encode();
3916
3917         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3918         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3919         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3920         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3921
3922         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3923         // nodes[3])
3924         let mut node_0_monitors_serialized = Vec::new();
3925         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3926                 let mut writer = test_utils::TestVecWriter(Vec::new());
3927                 monitor.1.write_for_disk(&mut writer).unwrap();
3928                 node_0_monitors_serialized.push(writer.0);
3929         }
3930
3931         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
3932         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);
3933         nodes[0].chan_monitor = &new_chan_monitor;
3934         let mut node_0_monitors = Vec::new();
3935         for serialized in node_0_monitors_serialized.iter() {
3936                 let mut read = &serialized[..];
3937                 let (_, monitor) = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3938                 assert!(read.is_empty());
3939                 node_0_monitors.push(monitor);
3940         }
3941
3942         let mut nodes_0_read = &nodes_0_serialized[..];
3943         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()));
3944         let (_, nodes_0_deserialized_tmp) = <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3945                 default_config: UserConfig::default(),
3946                 keys_manager: &keys_manager,
3947                 fee_estimator: &fee_estimator,
3948                 monitor: nodes[0].chan_monitor,
3949                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3950                 logger: Arc::new(test_utils::TestLogger::new()),
3951                 channel_monitors: &mut node_0_monitors.iter_mut().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3952         }).unwrap();
3953         nodes_0_deserialized = nodes_0_deserialized_tmp;
3954         assert!(nodes_0_read.is_empty());
3955
3956         { // Channel close should result in a commitment tx and an HTLC tx
3957                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3958                 assert_eq!(txn.len(), 2);
3959                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3960                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3961         }
3962
3963         for monitor in node_0_monitors.drain(..) {
3964                 assert!(nodes[0].chan_monitor.add_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3965                 check_added_monitors!(nodes[0], 1);
3966         }
3967         nodes[0].node = &nodes_0_deserialized;
3968
3969         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3970         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3971         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3972         //... and we can even still claim the payment!
3973         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3974
3975         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3976         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3977         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
3978         nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish);
3979         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
3980         assert_eq!(msg_events.len(), 1);
3981         if let MessageSendEvent::HandleError { ref action, .. } = msg_events[0] {
3982                 match action {
3983                         &ErrorAction::SendErrorMessage { ref msg } => {
3984                                 assert_eq!(msg.channel_id, channel_id);
3985                         },
3986                         _ => panic!("Unexpected event!"),
3987                 }
3988         }
3989 }
3990
3991 macro_rules! check_spendable_outputs {
3992         ($node: expr, $der_idx: expr) => {
3993                 {
3994                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3995                         let mut txn = Vec::new();
3996                         for event in events {
3997                                 match event {
3998                                         Event::SpendableOutputs { ref outputs } => {
3999                                                 for outp in outputs {
4000                                                         match *outp {
4001                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
4002                                                                         let input = TxIn {
4003                                                                                 previous_output: outpoint.clone(),
4004                                                                                 script_sig: Script::new(),
4005                                                                                 sequence: 0,
4006                                                                                 witness: Vec::new(),
4007                                                                         };
4008                                                                         let outp = TxOut {
4009                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4010                                                                                 value: output.value,
4011                                                                         };
4012                                                                         let mut spend_tx = Transaction {
4013                                                                                 version: 2,
4014                                                                                 lock_time: 0,
4015                                                                                 input: vec![input],
4016                                                                                 output: vec![outp],
4017                                                                         };
4018                                                                         let secp_ctx = Secp256k1::new();
4019                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
4020                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
4021                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4022                                                                         let remotesig = secp_ctx.sign(&sighash, key);
4023                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
4024                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4025                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
4026                                                                         txn.push(spend_tx);
4027                                                                 },
4028                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
4029                                                                         let input = TxIn {
4030                                                                                 previous_output: outpoint.clone(),
4031                                                                                 script_sig: Script::new(),
4032                                                                                 sequence: *to_self_delay as u32,
4033                                                                                 witness: Vec::new(),
4034                                                                         };
4035                                                                         let outp = TxOut {
4036                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4037                                                                                 value: output.value,
4038                                                                         };
4039                                                                         let mut spend_tx = Transaction {
4040                                                                                 version: 2,
4041                                                                                 lock_time: 0,
4042                                                                                 input: vec![input],
4043                                                                                 output: vec![outp],
4044                                                                         };
4045                                                                         let secp_ctx = Secp256k1::new();
4046                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
4047                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
4048                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
4049                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4050                                                                         spend_tx.input[0].witness.push(vec!(0));
4051                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
4052                                                                         txn.push(spend_tx);
4053                                                                 },
4054                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
4055                                                                         let secp_ctx = Secp256k1::new();
4056                                                                         let input = TxIn {
4057                                                                                 previous_output: outpoint.clone(),
4058                                                                                 script_sig: Script::new(),
4059                                                                                 sequence: 0,
4060                                                                                 witness: Vec::new(),
4061                                                                         };
4062                                                                         let outp = TxOut {
4063                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
4064                                                                                 value: output.value,
4065                                                                         };
4066                                                                         let mut spend_tx = Transaction {
4067                                                                                 version: 2,
4068                                                                                 lock_time: 0,
4069                                                                                 input: vec![input],
4070                                                                                 output: vec![outp.clone()],
4071                                                                         };
4072                                                                         let secret = {
4073                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
4074                                                                                         Ok(master_key) => {
4075                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
4076                                                                                                         Ok(key) => key,
4077                                                                                                         Err(_) => panic!("Your RNG is busted"),
4078                                                                                                 }
4079                                                                                         }
4080                                                                                         Err(_) => panic!("Your rng is busted"),
4081                                                                                 }
4082                                                                         };
4083                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
4084                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
4085                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
4086                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
4087                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
4088                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
4089                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
4090                                                                         txn.push(spend_tx);
4091                                                                 },
4092                                                         }
4093                                                 }
4094                                         },
4095                                         _ => panic!("Unexpected event"),
4096                                 };
4097                         }
4098                         txn
4099                 }
4100         }
4101 }
4102
4103 #[test]
4104 fn test_claim_sizeable_push_msat() {
4105         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
4106         let chanmon_cfgs = create_chanmon_cfgs(2);
4107         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4108         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4109         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4110
4111         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4112         nodes[1].node.force_close_channel(&chan.2);
4113         check_closed_broadcast!(nodes[1], false);
4114         check_added_monitors!(nodes[1], 1);
4115         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4116         assert_eq!(node_txn.len(), 1);
4117         check_spends!(node_txn[0], chan.3);
4118         assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
4119
4120         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4121         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4122         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4123
4124         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4125         assert_eq!(spend_txn.len(), 1);
4126         check_spends!(spend_txn[0], node_txn[0]);
4127 }
4128
4129 #[test]
4130 fn test_claim_on_remote_sizeable_push_msat() {
4131         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4132         // to_remote output is encumbered by a P2WPKH
4133         let chanmon_cfgs = create_chanmon_cfgs(2);
4134         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4135         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4136         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4137
4138         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, InitFeatures::supported(), InitFeatures::supported());
4139         nodes[0].node.force_close_channel(&chan.2);
4140         check_closed_broadcast!(nodes[0], false);
4141         check_added_monitors!(nodes[0], 1);
4142
4143         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4144         assert_eq!(node_txn.len(), 1);
4145         check_spends!(node_txn[0], chan.3);
4146         assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
4147
4148         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4149         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
4150         check_closed_broadcast!(nodes[1], false);
4151         check_added_monitors!(nodes[1], 1);
4152         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4153
4154         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4155         assert_eq!(spend_txn.len(), 2);
4156         assert_eq!(spend_txn[0], spend_txn[1]);
4157         check_spends!(spend_txn[0], node_txn[0]);
4158 }
4159
4160 #[test]
4161 fn test_claim_on_remote_revoked_sizeable_push_msat() {
4162         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
4163         // to_remote output is encumbered by a P2WPKH
4164
4165         let chanmon_cfgs = create_chanmon_cfgs(2);
4166         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4167         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4168         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4169
4170         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, InitFeatures::supported(), InitFeatures::supported());
4171         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4172         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan.2);
4173         assert_eq!(revoked_local_txn[0].input.len(), 1);
4174         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
4175
4176         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4177         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4178         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4179         check_closed_broadcast!(nodes[1], false);
4180         check_added_monitors!(nodes[1], 1);
4181
4182         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4183         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4184         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4185         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4186
4187         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4188         assert_eq!(spend_txn.len(), 3);
4189         assert_eq!(spend_txn[0], spend_txn[1]); // to_remote output on revoked remote commitment_tx
4190         check_spends!(spend_txn[0], revoked_local_txn[0]);
4191         check_spends!(spend_txn[2], node_txn[0]);
4192 }
4193
4194 #[test]
4195 fn test_static_spendable_outputs_preimage_tx() {
4196         let chanmon_cfgs = create_chanmon_cfgs(2);
4197         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4198         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4199         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4200
4201         // Create some initial channels
4202         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4203
4204         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4205
4206         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4207         assert_eq!(commitment_tx[0].input.len(), 1);
4208         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4209
4210         // Settle A's commitment tx on B's chain
4211         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4212         assert!(nodes[1].node.claim_funds(payment_preimage, 3_000_000));
4213         check_added_monitors!(nodes[1], 1);
4214         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
4215         check_added_monitors!(nodes[1], 1);
4216         let events = nodes[1].node.get_and_clear_pending_msg_events();
4217         match events[0] {
4218                 MessageSendEvent::UpdateHTLCs { .. } => {},
4219                 _ => panic!("Unexpected event"),
4220         }
4221         match events[1] {
4222                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4223                 _ => panic!("Unexepected event"),
4224         }
4225
4226         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
4227         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 2 (local commitment tx + HTLC-Success), ChannelMonitor: preimage tx
4228         assert_eq!(node_txn.len(), 3);
4229         check_spends!(node_txn[0], commitment_tx[0]);
4230         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4231         check_spends!(node_txn[1], chan_1.3);
4232         check_spends!(node_txn[2], node_txn[1]);
4233
4234         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4235         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4236         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4237
4238         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4239         assert_eq!(spend_txn.len(), 1);
4240         check_spends!(spend_txn[0], node_txn[0]);
4241 }
4242
4243 #[test]
4244 fn test_static_spendable_outputs_timeout_tx() {
4245         let chanmon_cfgs = create_chanmon_cfgs(2);
4246         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4247         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4248         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4249
4250         // Create some initial channels
4251         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4252
4253         // Rebalance the network a bit by relaying one payment through all the channels ...
4254         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4255
4256         let (_, our_payment_hash) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000);
4257
4258         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4259         assert_eq!(commitment_tx[0].input.len(), 1);
4260         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
4261
4262         // Settle A's commitment tx on B' chain
4263         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4264         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 0);
4265         check_added_monitors!(nodes[1], 1);
4266         let events = nodes[1].node.get_and_clear_pending_msg_events();
4267         match events[0] {
4268                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4269                 _ => panic!("Unexpected event"),
4270         }
4271
4272         // Check B's monitor was able to send back output descriptor event for timeout tx on A's commitment tx
4273         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4274         assert_eq!(node_txn.len(), 3); // ChannelManager : 2 (local commitent tx + HTLC-timeout), ChannelMonitor: timeout tx
4275         check_spends!(node_txn[0],  commitment_tx[0].clone());
4276         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4277         check_spends!(node_txn[1], chan_1.3.clone());
4278         check_spends!(node_txn[2], node_txn[1]);
4279
4280         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4281         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4282         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4283         let events = nodes[1].node.get_and_clear_pending_events();
4284         assert_eq!(events.len(), 1);
4285         match events[0] {
4286                 Event::PaymentFailed { payment_hash, .. } => {
4287                         assert_eq!(payment_hash, our_payment_hash);
4288                 },
4289                 _ => panic!("Unexpected event"),
4290         }
4291
4292         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4293         assert_eq!(spend_txn.len(), 3); // SpendableOutput: remote_commitment_tx.to_remote (*2), timeout_tx.output (*1)
4294         check_spends!(spend_txn[2], node_txn[0].clone());
4295 }
4296
4297 #[test]
4298 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
4299         let chanmon_cfgs = create_chanmon_cfgs(2);
4300         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4301         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4302         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4303
4304         // Create some initial channels
4305         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4306
4307         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4308         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4309         assert_eq!(revoked_local_txn[0].input.len(), 1);
4310         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4311
4312         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4313
4314         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4315         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 0);
4316         check_closed_broadcast!(nodes[1], false);
4317         check_added_monitors!(nodes[1], 1);
4318
4319         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4320         assert_eq!(node_txn.len(), 2);
4321         assert_eq!(node_txn[0].input.len(), 2);
4322         check_spends!(node_txn[0], revoked_local_txn[0]);
4323
4324         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4325         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone()] }, 1);
4326         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4327
4328         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4329         assert_eq!(spend_txn.len(), 1);
4330         check_spends!(spend_txn[0], node_txn[0]);
4331 }
4332
4333 #[test]
4334 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
4335         let chanmon_cfgs = create_chanmon_cfgs(2);
4336         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4337         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4338         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4339
4340         // Create some initial channels
4341         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4342
4343         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4344         let revoked_local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4345         assert_eq!(revoked_local_txn[0].input.len(), 1);
4346         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4347
4348         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4349
4350         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4351         // A will generate HTLC-Timeout from revoked commitment tx
4352         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4353         check_closed_broadcast!(nodes[0], false);
4354         check_added_monitors!(nodes[0], 1);
4355
4356         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4357         assert_eq!(revoked_htlc_txn.len(), 3);
4358         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4359         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4360         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4361         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4362         check_spends!(revoked_htlc_txn[1], chan_1.3);
4363
4364         // B will generate justice tx from A's revoked commitment/HTLC tx
4365         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 0);
4366         check_closed_broadcast!(nodes[1], false);
4367         check_added_monitors!(nodes[1], 1);
4368
4369         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4370         assert_eq!(node_txn.len(), 4); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-timeout, adjusted justice tx, ChannelManager: local commitment tx
4371         assert_eq!(node_txn[0].input.len(), 2);
4372         check_spends!(node_txn[0], revoked_local_txn[0]);
4373         check_spends!(node_txn[1], chan_1.3);
4374         assert_eq!(node_txn[2].input.len(), 1);
4375         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4376         assert_eq!(node_txn[3].input.len(), 1);
4377         check_spends!(node_txn[3], revoked_local_txn[0]);
4378
4379         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4380         nodes[1].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4381         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4382
4383         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
4384         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4385         assert_eq!(spend_txn.len(), 2);
4386         check_spends!(spend_txn[0], node_txn[0]);
4387         check_spends!(spend_txn[1], node_txn[2]);
4388 }
4389
4390 #[test]
4391 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
4392         let chanmon_cfgs = create_chanmon_cfgs(2);
4393         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4394         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4395         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4396
4397         // Create some initial channels
4398         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4399
4400         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4401         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4402         assert_eq!(revoked_local_txn[0].input.len(), 1);
4403         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4404
4405         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
4406
4407         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4408         // B will generate HTLC-Success from revoked commitment tx
4409         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4410         check_closed_broadcast!(nodes[1], false);
4411         check_added_monitors!(nodes[1], 1);
4412         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4413
4414         assert_eq!(revoked_htlc_txn.len(), 3);
4415         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
4416         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
4417         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4418         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
4419
4420         // A will generate justice tx from B's revoked commitment/HTLC tx
4421         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
4422         check_closed_broadcast!(nodes[0], false);
4423         check_added_monitors!(nodes[0], 1);
4424
4425         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4426         assert_eq!(node_txn.len(), 3); // ChannelMonitor: justice tx on revoked commitment, justice tx on revoked HTLC-success, ChannelManager: local commitment tx
4427         assert_eq!(node_txn[2].input.len(), 1);
4428         check_spends!(node_txn[2], revoked_htlc_txn[0]);
4429
4430         let header_1 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4431         nodes[0].block_notifier.block_connected(&Block { header: header_1, txdata: vec![node_txn[0].clone(), node_txn[2].clone()] }, 1);
4432         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
4433
4434         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
4435         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4436         assert_eq!(spend_txn.len(), 5); // Duplicated SpendableOutput due to block rescan after revoked htlc output tracking
4437         assert_eq!(spend_txn[0], spend_txn[1]);
4438         assert_eq!(spend_txn[0], spend_txn[2]);
4439         check_spends!(spend_txn[0], revoked_local_txn[0]); // spending to_remote output from revoked local tx
4440         check_spends!(spend_txn[3], node_txn[0]); // spending justice tx output from revoked local tx htlc received output
4441         check_spends!(spend_txn[4], node_txn[2]); // spending justice tx output on htlc success tx
4442 }
4443
4444 #[test]
4445 fn test_onchain_to_onchain_claim() {
4446         // Test that in case of channel closure, we detect the state of output thanks to
4447         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
4448         // First, have C claim an HTLC against its own latest commitment transaction.
4449         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
4450         // channel.
4451         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
4452         // gets broadcast.
4453
4454         let chanmon_cfgs = create_chanmon_cfgs(3);
4455         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4456         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4457         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4458
4459         // Create some initial channels
4460         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4461         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4462
4463         // Rebalance the network a bit by relaying one payment through all the channels ...
4464         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4465         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
4466
4467         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
4468         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
4469         let commitment_tx = get_local_commitment_txn!(nodes[2], chan_2.2);
4470         check_spends!(commitment_tx[0], chan_2.3);
4471         nodes[2].node.claim_funds(payment_preimage, 3_000_000);
4472         check_added_monitors!(nodes[2], 1);
4473         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4474         assert!(updates.update_add_htlcs.is_empty());
4475         assert!(updates.update_fail_htlcs.is_empty());
4476         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4477         assert!(updates.update_fail_malformed_htlcs.is_empty());
4478
4479         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4480         check_closed_broadcast!(nodes[2], false);
4481         check_added_monitors!(nodes[2], 1);
4482
4483         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
4484         assert_eq!(c_txn.len(), 4);
4485         assert_eq!(c_txn[0], c_txn[2]);
4486         assert_eq!(c_txn[0], c_txn[3]);
4487         assert_eq!(commitment_tx[0], c_txn[1]);
4488         check_spends!(c_txn[1], chan_2.3);
4489         check_spends!(c_txn[2], c_txn[1]);
4490         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
4491         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4492         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4493         assert_eq!(c_txn[0].lock_time, 0); // Success tx
4494
4495         // 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
4496         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
4497         {
4498                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4499                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-timeout tx
4500                 assert_eq!(b_txn.len(), 3);
4501                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
4502                 check_spends!(b_txn[2], b_txn[1]); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
4503                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4504                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
4505                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4506                 check_spends!(b_txn[0], c_txn[1]); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
4507                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4508                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4509                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
4510                 b_txn.clear();
4511         }
4512         check_added_monitors!(nodes[1], 1);
4513         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4514         check_added_monitors!(nodes[1], 1);
4515         match msg_events[0] {
4516                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
4517                 _ => panic!("Unexpected event"),
4518         }
4519         match msg_events[1] {
4520                 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, .. } } => {
4521                         assert!(update_add_htlcs.is_empty());
4522                         assert!(update_fail_htlcs.is_empty());
4523                         assert_eq!(update_fulfill_htlcs.len(), 1);
4524                         assert!(update_fail_malformed_htlcs.is_empty());
4525                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
4526                 },
4527                 _ => panic!("Unexpected event"),
4528         };
4529         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
4530         let commitment_tx = get_local_commitment_txn!(nodes[0], chan_1.2);
4531         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
4532         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4533         // ChannelMonitor: HTLC-Success tx, ChannelManager: local commitment tx + HTLC-Success tx
4534         assert_eq!(b_txn.len(), 3);
4535         check_spends!(b_txn[1], chan_1.3);
4536         check_spends!(b_txn[2], b_txn[1]);
4537         check_spends!(b_txn[0], commitment_tx[0]);
4538         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4539         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
4540         assert_eq!(b_txn[0].lock_time, 0); // Success tx
4541
4542         check_closed_broadcast!(nodes[1], false);
4543         check_added_monitors!(nodes[1], 1);
4544 }
4545
4546 #[test]
4547 fn test_duplicate_payment_hash_one_failure_one_success() {
4548         // Topology : A --> B --> C
4549         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
4550         let chanmon_cfgs = create_chanmon_cfgs(3);
4551         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
4552         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
4553         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
4554
4555         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4556         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4557
4558         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4559         *nodes[0].network_payment_count.borrow_mut() -= 1;
4560         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4561
4562         let commitment_txn = get_local_commitment_txn!(nodes[2], chan_2.2);
4563         assert_eq!(commitment_txn[0].input.len(), 1);
4564         check_spends!(commitment_txn[0], chan_2.3);
4565
4566         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4567         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4568         check_closed_broadcast!(nodes[1], false);
4569         check_added_monitors!(nodes[1], 1);
4570
4571         let htlc_timeout_tx;
4572         { // Extract one of the two HTLC-Timeout transaction
4573                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4574                 // ChannelMonitor: timeout tx * 2, ChannelManager: local commitment tx + HTLC-timeout * 2
4575                 assert_eq!(node_txn.len(), 5);
4576                 check_spends!(node_txn[0], commitment_txn[0]);
4577                 assert_eq!(node_txn[0].input.len(), 1);
4578                 check_spends!(node_txn[1], commitment_txn[0]);
4579                 assert_eq!(node_txn[1].input.len(), 1);
4580                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4581                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4582                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4583                 check_spends!(node_txn[2], chan_2.3);
4584                 check_spends!(node_txn[3], node_txn[2]);
4585                 check_spends!(node_txn[4], node_txn[2]);
4586                 htlc_timeout_tx = node_txn[1].clone();
4587         }
4588
4589         nodes[2].node.claim_funds(our_payment_preimage, 900_000);
4590         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4591         check_added_monitors!(nodes[2], 3);
4592         let events = nodes[2].node.get_and_clear_pending_msg_events();
4593         match events[0] {
4594                 MessageSendEvent::UpdateHTLCs { .. } => {},
4595                 _ => panic!("Unexpected event"),
4596         }
4597         match events[1] {
4598                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4599                 _ => panic!("Unexepected event"),
4600         }
4601         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4602         assert_eq!(htlc_success_txn.len(), 7);
4603         check_spends!(htlc_success_txn[2], chan_2.3);
4604         check_spends!(htlc_success_txn[3], htlc_success_txn[2]);
4605         check_spends!(htlc_success_txn[4], htlc_success_txn[2]);
4606         assert_eq!(htlc_success_txn[0], htlc_success_txn[5]);
4607         assert_eq!(htlc_success_txn[0].input.len(), 1);
4608         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4609         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4610         assert_eq!(htlc_success_txn[1].input.len(), 1);
4611         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4612         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4613         check_spends!(htlc_success_txn[0], commitment_txn[0]);
4614         check_spends!(htlc_success_txn[1], commitment_txn[0]);
4615
4616         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4617         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4618         expect_pending_htlcs_forwardable!(nodes[1]);
4619         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4620         assert!(htlc_updates.update_add_htlcs.is_empty());
4621         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4622         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4623         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4624         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4625         check_added_monitors!(nodes[1], 1);
4626
4627         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]);
4628         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4629         {
4630                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4631                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4632                 assert_eq!(events.len(), 1);
4633                 match events[0] {
4634                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4635                         },
4636                         _ => { panic!("Unexpected event"); }
4637                 }
4638         }
4639         let events = nodes[0].node.get_and_clear_pending_events();
4640         match events[0] {
4641                 Event::PaymentFailed { ref payment_hash, .. } => {
4642                         assert_eq!(*payment_hash, duplicate_payment_hash);
4643                 }
4644                 _ => panic!("Unexpected event"),
4645         }
4646
4647         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4648         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4649         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4650         assert!(updates.update_add_htlcs.is_empty());
4651         assert!(updates.update_fail_htlcs.is_empty());
4652         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4653         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4654         assert!(updates.update_fail_malformed_htlcs.is_empty());
4655         check_added_monitors!(nodes[1], 1);
4656
4657         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]);
4658         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4659
4660         let events = nodes[0].node.get_and_clear_pending_events();
4661         match events[0] {
4662                 Event::PaymentSent { ref payment_preimage } => {
4663                         assert_eq!(*payment_preimage, our_payment_preimage);
4664                 }
4665                 _ => panic!("Unexpected event"),
4666         }
4667 }
4668
4669 #[test]
4670 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4671         let chanmon_cfgs = create_chanmon_cfgs(2);
4672         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4673         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4674         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4675
4676         // Create some initial channels
4677         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4678
4679         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4680         let local_txn = get_local_commitment_txn!(nodes[1], chan_1.2);
4681         assert_eq!(local_txn[0].input.len(), 1);
4682         check_spends!(local_txn[0], chan_1.3);
4683
4684         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4685         nodes[1].node.claim_funds(payment_preimage, 9_000_000);
4686         check_added_monitors!(nodes[1], 1);
4687         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4688         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4689         check_added_monitors!(nodes[1], 1);
4690         let events = nodes[1].node.get_and_clear_pending_msg_events();
4691         match events[0] {
4692                 MessageSendEvent::UpdateHTLCs { .. } => {},
4693                 _ => panic!("Unexpected event"),
4694         }
4695         match events[1] {
4696                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4697                 _ => panic!("Unexepected event"),
4698         }
4699         let node_txn = {
4700                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4701                 assert_eq!(node_txn[0].input.len(), 1);
4702                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4703                 check_spends!(node_txn[0], local_txn[0]);
4704                 vec![node_txn[0].clone(), node_txn[2].clone()]
4705         };
4706
4707         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4708         nodes[1].block_notifier.block_connected(&Block { header: header_201, txdata: node_txn.clone() }, 201);
4709         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
4710
4711         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4712         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4713         assert_eq!(spend_txn.len(), 2);
4714         check_spends!(spend_txn[0], node_txn[0]);
4715         check_spends!(spend_txn[1], node_txn[1]);
4716 }
4717
4718 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4719         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4720         // unrevoked commitment transaction.
4721         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4722         // a remote RAA before they could be failed backwards (and combinations thereof).
4723         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4724         // use the same payment hashes.
4725         // Thus, we use a six-node network:
4726         //
4727         // A \         / E
4728         //    - C - D -
4729         // B /         \ F
4730         // And test where C fails back to A/B when D announces its latest commitment transaction
4731         let chanmon_cfgs = create_chanmon_cfgs(6);
4732         let node_cfgs = create_node_cfgs(6, &chanmon_cfgs);
4733         let node_chanmgrs = create_node_chanmgrs(6, &node_cfgs, &[None, None, None, None, None, None]);
4734         let nodes = create_network(6, &node_cfgs, &node_chanmgrs);
4735
4736         create_announced_chan_between_nodes(&nodes, 0, 2, InitFeatures::supported(), InitFeatures::supported());
4737         create_announced_chan_between_nodes(&nodes, 1, 2, InitFeatures::supported(), InitFeatures::supported());
4738         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, InitFeatures::supported(), InitFeatures::supported());
4739         create_announced_chan_between_nodes(&nodes, 3, 4, InitFeatures::supported(), InitFeatures::supported());
4740         create_announced_chan_between_nodes(&nodes, 3, 5, InitFeatures::supported(), InitFeatures::supported());
4741
4742         // Rebalance and check output sanity...
4743         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4744         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4745         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 2);
4746
4747         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4748         // 0th HTLC:
4749         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
4750         // 1st HTLC:
4751         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
4752         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();
4753         // 2nd HTLC:
4754         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
4755         // 3rd HTLC:
4756         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
4757         // 4th HTLC:
4758         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4759         // 5th HTLC:
4760         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4761         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4762         // 6th HTLC:
4763         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4764         // 7th HTLC:
4765         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4766
4767         // 8th HTLC:
4768         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4769         // 9th HTLC:
4770         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();
4771         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
4772
4773         // 10th HTLC:
4774         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
4775         // 11th HTLC:
4776         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4777         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4778
4779         // Double-check that six of the new HTLC were added
4780         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4781         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4782         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2).len(), 1);
4783         assert_eq!(get_local_commitment_txn!(nodes[3], chan.2)[0].output.len(), 8);
4784
4785         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4786         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4787         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4788         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4789         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4790         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4791         check_added_monitors!(nodes[4], 0);
4792         expect_pending_htlcs_forwardable!(nodes[4]);
4793         check_added_monitors!(nodes[4], 1);
4794
4795         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4796         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]);
4797         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]);
4798         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]);
4799         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]);
4800         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4801
4802         // Fail 3rd below-dust and 7th above-dust HTLCs
4803         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4804         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4805         check_added_monitors!(nodes[5], 0);
4806         expect_pending_htlcs_forwardable!(nodes[5]);
4807         check_added_monitors!(nodes[5], 1);
4808
4809         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4810         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]);
4811         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]);
4812         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4813
4814         let ds_prev_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4815
4816         expect_pending_htlcs_forwardable!(nodes[3]);
4817         check_added_monitors!(nodes[3], 1);
4818         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4819         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]);
4820         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]);
4821         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]);
4822         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]);
4823         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]);
4824         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]);
4825         if deliver_last_raa {
4826                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4827         } else {
4828                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4829         }
4830
4831         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4832         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4833         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4834         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4835         //
4836         // We now broadcast the latest commitment transaction, which *should* result in failures for
4837         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4838         // the non-broadcast above-dust HTLCs.
4839         //
4840         // Alternatively, we may broadcast the previous commitment transaction, which should only
4841         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4842         let ds_last_commitment_tx = get_local_commitment_txn!(nodes[3], chan.2);
4843
4844         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4845         if announce_latest {
4846                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4847         } else {
4848                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4849         }
4850         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4851         check_closed_broadcast!(nodes[2], false);
4852         expect_pending_htlcs_forwardable!(nodes[2]);
4853         check_added_monitors!(nodes[2], 3);
4854
4855         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4856         assert_eq!(cs_msgs.len(), 2);
4857         let mut a_done = false;
4858         for msg in cs_msgs {
4859                 match msg {
4860                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4861                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4862                                 // should be failed-backwards here.
4863                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4864                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4865                                         for htlc in &updates.update_fail_htlcs {
4866                                                 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 });
4867                                         }
4868                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4869                                         assert!(!a_done);
4870                                         a_done = true;
4871                                         &nodes[0]
4872                                 } else {
4873                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4874                                         for htlc in &updates.update_fail_htlcs {
4875                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4876                                         }
4877                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4878                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4879                                         &nodes[1]
4880                                 };
4881                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]);
4882                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]);
4883                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]);
4884                                 if announce_latest {
4885                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]);
4886                                         if *node_id == nodes[0].node.get_our_node_id() {
4887                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]);
4888                                         }
4889                                 }
4890                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4891                         },
4892                         _ => panic!("Unexpected event"),
4893                 }
4894         }
4895
4896         let as_events = nodes[0].node.get_and_clear_pending_events();
4897         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4898         let mut as_failds = HashSet::new();
4899         for event in as_events.iter() {
4900                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4901                         assert!(as_failds.insert(*payment_hash));
4902                         if *payment_hash != payment_hash_2 {
4903                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4904                         } else {
4905                                 assert!(!rejected_by_dest);
4906                         }
4907                 } else { panic!("Unexpected event"); }
4908         }
4909         assert!(as_failds.contains(&payment_hash_1));
4910         assert!(as_failds.contains(&payment_hash_2));
4911         if announce_latest {
4912                 assert!(as_failds.contains(&payment_hash_3));
4913                 assert!(as_failds.contains(&payment_hash_5));
4914         }
4915         assert!(as_failds.contains(&payment_hash_6));
4916
4917         let bs_events = nodes[1].node.get_and_clear_pending_events();
4918         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4919         let mut bs_failds = HashSet::new();
4920         for event in bs_events.iter() {
4921                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4922                         assert!(bs_failds.insert(*payment_hash));
4923                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4924                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4925                         } else {
4926                                 assert!(!rejected_by_dest);
4927                         }
4928                 } else { panic!("Unexpected event"); }
4929         }
4930         assert!(bs_failds.contains(&payment_hash_1));
4931         assert!(bs_failds.contains(&payment_hash_2));
4932         if announce_latest {
4933                 assert!(bs_failds.contains(&payment_hash_4));
4934         }
4935         assert!(bs_failds.contains(&payment_hash_5));
4936
4937         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4938         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4939         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4940         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4941         // PaymentFailureNetworkUpdates.
4942         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4943         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4944         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4945         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4946         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4947                 match event {
4948                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4949                         _ => panic!("Unexpected event"),
4950                 }
4951         }
4952 }
4953
4954 #[test]
4955 fn test_fail_backwards_latest_remote_announce_a() {
4956         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4957 }
4958
4959 #[test]
4960 fn test_fail_backwards_latest_remote_announce_b() {
4961         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4962 }
4963
4964 #[test]
4965 fn test_fail_backwards_previous_remote_announce() {
4966         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4967         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4968         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4969 }
4970
4971 #[test]
4972 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4973         let chanmon_cfgs = create_chanmon_cfgs(2);
4974         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
4975         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
4976         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
4977
4978         // Create some initial channels
4979         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
4980
4981         let (_, our_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000);
4982         let local_txn = get_local_commitment_txn!(nodes[0], chan_1.2);
4983         assert_eq!(local_txn[0].input.len(), 1);
4984         check_spends!(local_txn[0], chan_1.3);
4985
4986         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4987         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4988         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4989         check_closed_broadcast!(nodes[0], false);
4990         check_added_monitors!(nodes[0], 1);
4991
4992         let htlc_timeout = {
4993                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4994                 assert_eq!(node_txn[0].input.len(), 1);
4995                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4996                 check_spends!(node_txn[0], local_txn[0]);
4997                 node_txn[0].clone()
4998         };
4999
5000         let header_201 = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5001         nodes[0].block_notifier.block_connected(&Block { header: header_201, txdata: vec![htlc_timeout.clone()] }, 201);
5002         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 201, true, header_201.bitcoin_hash());
5003         let events = nodes[0].node.get_and_clear_pending_events();
5004         assert_eq!(events.len(), 1);
5005         match events[0] {
5006                 Event::PaymentFailed { payment_hash, .. } => {
5007                         assert_eq!(payment_hash, our_payment_hash);
5008                 },
5009                 _ => panic!("Unexpected event"),
5010         }
5011
5012         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
5013         let spend_txn = check_spendable_outputs!(nodes[0], 1);
5014         assert_eq!(spend_txn.len(), 3);
5015         assert_eq!(spend_txn[0], spend_txn[1]);
5016         check_spends!(spend_txn[0], local_txn[0]);
5017         check_spends!(spend_txn[2], htlc_timeout);
5018 }
5019
5020 #[test]
5021 fn test_static_output_closing_tx() {
5022         let chanmon_cfgs = create_chanmon_cfgs(2);
5023         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5024         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5025         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5026
5027         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5028
5029         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5030         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
5031
5032         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5033         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5034         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5035
5036         let spend_txn = check_spendable_outputs!(nodes[0], 2);
5037         assert_eq!(spend_txn.len(), 1);
5038         check_spends!(spend_txn[0], closing_tx);
5039
5040         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 0);
5041         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
5042
5043         let spend_txn = check_spendable_outputs!(nodes[1], 2);
5044         assert_eq!(spend_txn.len(), 1);
5045         check_spends!(spend_txn[0], closing_tx);
5046 }
5047
5048 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
5049         let chanmon_cfgs = create_chanmon_cfgs(2);
5050         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5051         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5052         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5053         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5054
5055         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
5056
5057         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
5058         // present in B's local commitment transaction, but none of A's commitment transactions.
5059         assert!(nodes[1].node.claim_funds(our_payment_preimage, if use_dust { 50_000 } else { 3_000_000 }));
5060         check_added_monitors!(nodes[1], 1);
5061
5062         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5063         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]);
5064         let events = nodes[0].node.get_and_clear_pending_events();
5065         assert_eq!(events.len(), 1);
5066         match events[0] {
5067                 Event::PaymentSent { payment_preimage } => {
5068                         assert_eq!(payment_preimage, our_payment_preimage);
5069                 },
5070                 _ => panic!("Unexpected event"),
5071         }
5072
5073         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5074         check_added_monitors!(nodes[0], 1);
5075         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5076         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5077         check_added_monitors!(nodes[1], 1);
5078
5079         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5080         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
5081                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5082                 header.prev_blockhash = header.bitcoin_hash();
5083         }
5084         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
5085         check_closed_broadcast!(nodes[1], false);
5086         check_added_monitors!(nodes[1], 1);
5087 }
5088
5089 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
5090         let chanmon_cfgs = create_chanmon_cfgs(2);
5091         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5092         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5093         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5094         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5095
5096         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();
5097         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5098         nodes[0].node.send_payment(route, payment_hash).unwrap();
5099         check_added_monitors!(nodes[0], 1);
5100
5101         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5102
5103         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
5104         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
5105         // to "time out" the HTLC.
5106
5107         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5108
5109         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5110                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
5111                 header.prev_blockhash = header.bitcoin_hash();
5112         }
5113         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5114         check_closed_broadcast!(nodes[0], false);
5115         check_added_monitors!(nodes[0], 1);
5116 }
5117
5118 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
5119         let chanmon_cfgs = create_chanmon_cfgs(3);
5120         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5121         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5122         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5123         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
5124
5125         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
5126         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
5127         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
5128         // actually revoked.
5129         let htlc_value = if use_dust { 50000 } else { 3000000 };
5130         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
5131         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
5132         expect_pending_htlcs_forwardable!(nodes[1]);
5133         check_added_monitors!(nodes[1], 1);
5134
5135         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5136         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]);
5137         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed);
5138         check_added_monitors!(nodes[0], 1);
5139         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5140         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0);
5141         check_added_monitors!(nodes[1], 1);
5142         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1);
5143         check_added_monitors!(nodes[1], 1);
5144         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5145
5146         if check_revoke_no_close {
5147                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack);
5148                 check_added_monitors!(nodes[0], 1);
5149         }
5150
5151         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5152         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
5153                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
5154                 header.prev_blockhash = header.bitcoin_hash();
5155         }
5156         if !check_revoke_no_close {
5157                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
5158                 check_closed_broadcast!(nodes[0], false);
5159                 check_added_monitors!(nodes[0], 1);
5160         } else {
5161                 let events = nodes[0].node.get_and_clear_pending_events();
5162                 assert_eq!(events.len(), 1);
5163                 match events[0] {
5164                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
5165                                 assert_eq!(payment_hash, our_payment_hash);
5166                                 assert!(rejected_by_dest);
5167                         },
5168                         _ => panic!("Unexpected event"),
5169                 }
5170         }
5171 }
5172
5173 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
5174 // There are only a few cases to test here:
5175 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
5176 //    broadcastable commitment transactions result in channel closure,
5177 //  * its included in an unrevoked-but-previous remote commitment transaction,
5178 //  * its included in the latest remote or local commitment transactions.
5179 // We test each of the three possible commitment transactions individually and use both dust and
5180 // non-dust HTLCs.
5181 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
5182 // assume they are handled the same across all six cases, as both outbound and inbound failures are
5183 // tested for at least one of the cases in other tests.
5184 #[test]
5185 fn htlc_claim_single_commitment_only_a() {
5186         do_htlc_claim_local_commitment_only(true);
5187         do_htlc_claim_local_commitment_only(false);
5188
5189         do_htlc_claim_current_remote_commitment_only(true);
5190         do_htlc_claim_current_remote_commitment_only(false);
5191 }
5192
5193 #[test]
5194 fn htlc_claim_single_commitment_only_b() {
5195         do_htlc_claim_previous_remote_commitment_only(true, false);
5196         do_htlc_claim_previous_remote_commitment_only(false, false);
5197         do_htlc_claim_previous_remote_commitment_only(true, true);
5198         do_htlc_claim_previous_remote_commitment_only(false, true);
5199 }
5200
5201 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>)
5202         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5203                                 F2: FnMut(),
5204 {
5205         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);
5206 }
5207
5208 // test_case
5209 // 0: node1 fails backward
5210 // 1: final node fails backward
5211 // 2: payment completed but the user rejects the payment
5212 // 3: final node fails backward (but tamper onion payloads from node0)
5213 // 100: trigger error in the intermediate node and tamper returning fail_htlc
5214 // 200: trigger error in the final node and tamper returning fail_htlc
5215 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>)
5216         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
5217                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
5218                                 F3: FnMut(),
5219 {
5220
5221         // reset block height
5222         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5223         for ix in 0..nodes.len() {
5224                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
5225         }
5226
5227         macro_rules! expect_event {
5228                 ($node: expr, $event_type: path) => {{
5229                         let events = $node.node.get_and_clear_pending_events();
5230                         assert_eq!(events.len(), 1);
5231                         match events[0] {
5232                                 $event_type { .. } => {},
5233                                 _ => panic!("Unexpected event"),
5234                         }
5235                 }}
5236         }
5237
5238         macro_rules! expect_htlc_forward {
5239                 ($node: expr) => {{
5240                         expect_event!($node, Event::PendingHTLCsForwardable);
5241                         $node.node.process_pending_htlc_forwards();
5242                 }}
5243         }
5244
5245         // 0 ~~> 2 send payment
5246         nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
5247         check_added_monitors!(nodes[0], 1);
5248         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5249         // temper update_add (0 => 1)
5250         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
5251         if test_case == 0 || test_case == 3 || test_case == 100 {
5252                 callback_msg(&mut update_add_0);
5253                 callback_node();
5254         }
5255         // 0 => 1 update_add & CS
5256         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0);
5257         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
5258
5259         let update_1_0 = match test_case {
5260                 0|100 => { // intermediate node failure; fail backward to 0
5261                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5262                         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));
5263                         update_1_0
5264                 },
5265                 1|2|3|200 => { // final node failure; forwarding to 2
5266                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5267                         // forwarding on 1
5268                         if test_case != 200 {
5269                                 callback_node();
5270                         }
5271                         expect_htlc_forward!(&nodes[1]);
5272
5273                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
5274                         check_added_monitors!(&nodes[1], 1);
5275                         assert_eq!(update_1.update_add_htlcs.len(), 1);
5276                         // tamper update_add (1 => 2)
5277                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
5278                         if test_case != 3 && test_case != 200 {
5279                                 callback_msg(&mut update_add_1);
5280                         }
5281
5282                         // 1 => 2
5283                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1);
5284                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
5285
5286                         if test_case == 2 || test_case == 200 {
5287                                 expect_htlc_forward!(&nodes[2]);
5288                                 expect_event!(&nodes[2], Event::PaymentReceived);
5289                                 callback_node();
5290                                 expect_pending_htlcs_forwardable!(nodes[2]);
5291                         }
5292
5293                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5294                         if test_case == 2 || test_case == 200 {
5295                                 check_added_monitors!(&nodes[2], 1);
5296                         }
5297                         assert!(update_2_1.update_fail_htlcs.len() == 1);
5298
5299                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
5300                         if test_case == 200 {
5301                                 callback_fail(&mut fail_msg);
5302                         }
5303
5304                         // 2 => 1
5305                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg);
5306                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
5307
5308                         // backward fail on 1
5309                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5310                         assert!(update_1_0.update_fail_htlcs.len() == 1);
5311                         update_1_0
5312                 },
5313                 _ => unreachable!(),
5314         };
5315
5316         // 1 => 0 commitment_signed_dance
5317         if update_1_0.update_fail_htlcs.len() > 0 {
5318                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
5319                 if test_case == 100 {
5320                         callback_fail(&mut fail_msg);
5321                 }
5322                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg);
5323         } else {
5324                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]);
5325         };
5326
5327         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
5328
5329         let events = nodes[0].node.get_and_clear_pending_events();
5330         assert_eq!(events.len(), 1);
5331         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
5332                 assert_eq!(*rejected_by_dest, !expected_retryable);
5333                 assert_eq!(*error_code, expected_error_code);
5334         } else {
5335                 panic!("Uexpected event");
5336         }
5337
5338         let events = nodes[0].node.get_and_clear_pending_msg_events();
5339         if expected_channel_update.is_some() {
5340                 assert_eq!(events.len(), 1);
5341                 match events[0] {
5342                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
5343                                 match update {
5344                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
5345                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
5346                                                         panic!("channel_update not found!");
5347                                                 }
5348                                         },
5349                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
5350                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5351                                                         assert!(*short_channel_id == *expected_short_channel_id);
5352                                                         assert!(*is_permanent == *expected_is_permanent);
5353                                                 } else {
5354                                                         panic!("Unexpected message event");
5355                                                 }
5356                                         },
5357                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
5358                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
5359                                                         assert!(*node_id == *expected_node_id);
5360                                                         assert!(*is_permanent == *expected_is_permanent);
5361                                                 } else {
5362                                                         panic!("Unexpected message event");
5363                                                 }
5364                                         },
5365                                 }
5366                         },
5367                         _ => panic!("Unexpected message event"),
5368                 }
5369         } else {
5370                 assert_eq!(events.len(), 0);
5371         }
5372 }
5373
5374 impl msgs::ChannelUpdate {
5375         fn dummy() -> msgs::ChannelUpdate {
5376                 use secp256k1::ffi::Signature as FFISignature;
5377                 use secp256k1::Signature;
5378                 msgs::ChannelUpdate {
5379                         signature: Signature::from(FFISignature::new()),
5380                         contents: msgs::UnsignedChannelUpdate {
5381                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
5382                                 short_channel_id: 0,
5383                                 timestamp: 0,
5384                                 flags: 0,
5385                                 cltv_expiry_delta: 0,
5386                                 htlc_minimum_msat: 0,
5387                                 fee_base_msat: 0,
5388                                 fee_proportional_millionths: 0,
5389                                 excess_data: vec![],
5390                         }
5391                 }
5392         }
5393 }
5394
5395 struct BogusOnionHopData {
5396         data: Vec<u8>
5397 }
5398 impl BogusOnionHopData {
5399         fn new(orig: msgs::OnionHopData) -> Self {
5400                 Self { data: orig.encode() }
5401         }
5402 }
5403 impl Writeable for BogusOnionHopData {
5404         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), io::Error> {
5405                 writer.write_all(&self.data[..])
5406         }
5407 }
5408
5409 #[test]
5410 fn test_onion_failure() {
5411         use ln::msgs::ChannelUpdate;
5412         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
5413         use secp256k1;
5414
5415         const BADONION: u16 = 0x8000;
5416         const PERM: u16 = 0x4000;
5417         const NODE: u16 = 0x2000;
5418         const UPDATE: u16 = 0x1000;
5419
5420         let chanmon_cfgs = create_chanmon_cfgs(3);
5421         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
5422         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
5423         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
5424         for node in nodes.iter() {
5425                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
5426         }
5427         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())];
5428         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5429         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
5430         // positve case
5431         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
5432
5433         // intermediate node failure
5434         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
5435                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5436                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5437                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5438                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5439                 let mut new_payloads = Vec::new();
5440                 for payload in onion_payloads.drain(..) {
5441                         new_payloads.push(BogusOnionHopData::new(payload));
5442                 }
5443                 // break the first (non-final) hop payload by swapping the realm (0) byte for a byte
5444                 // describing a length-1 TLV payload, which is obviously bogus.
5445                 new_payloads[0].data[0] = 1;
5446                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5447         }, ||{}, 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
5448
5449         // final node failure
5450         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
5451                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5452                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5453                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5454                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5455                 let mut new_payloads = Vec::new();
5456                 for payload in onion_payloads.drain(..) {
5457                         new_payloads.push(BogusOnionHopData::new(payload));
5458                 }
5459                 // break the last-hop payload by swapping the realm (0) byte for a byte describing a
5460                 // length-1 TLV payload, which is obviously bogus.
5461                 new_payloads[1].data[0] = 1;
5462                 msg.onion_routing_packet = onion_utils::construct_onion_packet_bogus_hopdata(new_payloads, onion_keys, [0; 32], &payment_hash);
5463         }, ||{}, false, Some(PERM|22), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5464
5465         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
5466         // receiving simulated fail messages
5467         // intermediate node failure
5468         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5469                 // trigger error
5470                 msg.amount_msat -= 1;
5471         }, |msg| {
5472                 // and tamper returning error message
5473                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5474                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5475                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
5476         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
5477
5478         // final node failure
5479         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5480                 // and tamper returning error message
5481                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5482                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5483                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
5484         }, ||{
5485                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5486         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
5487
5488         // intermediate node failure
5489         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
5490                 msg.amount_msat -= 1;
5491         }, |msg| {
5492                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5493                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5494                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
5495         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5496
5497         // final node failure
5498         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5499                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5500                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5501                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
5502         }, ||{
5503                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5504         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5505
5506         // intermediate node failure
5507         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5508                 msg.amount_msat -= 1;
5509         }, |msg| {
5510                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5511                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5512                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
5513         }, ||{
5514                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5515         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
5516
5517         // final node failure
5518         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
5519                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5520                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5521                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
5522         }, ||{
5523                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5524         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
5525
5526         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
5527                 Some(BADONION|PERM|4), None);
5528
5529         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
5530                 Some(BADONION|PERM|5), None);
5531
5532         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
5533                 Some(BADONION|PERM|6), None);
5534
5535         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5536                 msg.amount_msat -= 1;
5537         }, |msg| {
5538                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5539                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5540                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
5541         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5542
5543         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
5544                 msg.amount_msat -= 1;
5545         }, |msg| {
5546                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5547                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5548                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
5549                 // short_channel_id from the processing node
5550         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5551
5552         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
5553                 msg.amount_msat -= 1;
5554         }, |msg| {
5555                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5556                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5557                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
5558                 // short_channel_id from the processing node
5559         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
5560
5561         let mut bogus_route = route.clone();
5562         bogus_route.hops[1].short_channel_id -= 1;
5563         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
5564           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
5565
5566         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
5567         let mut bogus_route = route.clone();
5568         let route_len = bogus_route.hops.len();
5569         bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
5570         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5571
5572         //TODO: with new config API, we will be able to generate both valid and
5573         //invalid channel_update cases.
5574         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
5575                 msg.amount_msat -= 1;
5576         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5577
5578         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
5579                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
5580                 msg.cltv_expiry -= 1;
5581         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
5582
5583         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
5584                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5585                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5586
5587                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
5588         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5589
5590         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
5591                 nodes[2].node.fail_htlc_backwards(&payment_hash);
5592         }, false, Some(PERM|15), None);
5593
5594         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
5595                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
5596                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5597
5598                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
5599         }, || {}, true, Some(17), None);
5600
5601         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
5602                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5603                         for f in pending_forwards.iter_mut() {
5604                                 match f {
5605                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5606                                                 forward_info.outgoing_cltv_value += 1,
5607                                         _ => {},
5608                                 }
5609                         }
5610                 }
5611         }, true, Some(18), None);
5612
5613         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
5614                 // violate amt_to_forward > msg.amount_msat
5615                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().forward_htlcs.iter_mut() {
5616                         for f in pending_forwards.iter_mut() {
5617                                 match f {
5618                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
5619                                                 forward_info.amt_to_forward -= 1,
5620                                         _ => {},
5621                                 }
5622                         }
5623                 }
5624         }, true, Some(19), None);
5625
5626         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
5627                 // disconnect event to the channel between nodes[1] ~ nodes[2]
5628                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
5629                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5630         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
5631         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5632
5633         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5634                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5635                 let mut route = route.clone();
5636                 let height = 1;
5637                 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
5638                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5639                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
5640                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &payment_hash);
5641                 msg.cltv_expiry = htlc_cltv;
5642                 msg.onion_routing_packet = onion_packet;
5643         }, ||{}, true, Some(21), None);
5644 }
5645
5646 #[test]
5647 #[should_panic]
5648 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5649         let chanmon_cfgs = create_chanmon_cfgs(2);
5650         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5651         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5652         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5653         //Force duplicate channel ids
5654         for node in nodes.iter() {
5655                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5656         }
5657
5658         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5659         let channel_value_satoshis=10000;
5660         let push_msat=10001;
5661         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).unwrap();
5662         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5663         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &node0_to_1_send_open_channel);
5664
5665         //Create a second channel with a channel_id collision
5666         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5667 }
5668
5669 #[test]
5670 fn bolt2_open_channel_sending_node_checks_part2() {
5671         let chanmon_cfgs = create_chanmon_cfgs(2);
5672         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5673         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5674         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5675
5676         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5677         let channel_value_satoshis=2^24;
5678         let push_msat=10001;
5679         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5680
5681         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5682         let channel_value_satoshis=10000;
5683         // Test when push_msat is equal to 1000 * funding_satoshis.
5684         let push_msat=1000*channel_value_satoshis+1;
5685         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42, None).is_err());
5686
5687         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5688         let channel_value_satoshis=10000;
5689         let push_msat=10001;
5690         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
5691         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5692         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5693
5694         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5695         // 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
5696         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5697
5698         // 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.
5699         assert!(BREAKDOWN_TIMEOUT>0);
5700         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5701
5702         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5703         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5704         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5705
5706         // 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.
5707         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5708         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5709         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5710         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5711         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5712 }
5713
5714 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5715 // 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.
5716 //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.
5717
5718 #[test]
5719 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5720         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5721         let chanmon_cfgs = create_chanmon_cfgs(2);
5722         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5723         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5724         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5725         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5726         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5727         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5728
5729         route.hops[0].fee_msat = 100;
5730
5731         let err = nodes[0].node.send_payment(route, our_payment_hash);
5732
5733         if let Err(APIError::ChannelUnavailable{err}) = err {
5734                 assert_eq!(err, "Cannot send less than their minimum HTLC value");
5735         } else {
5736                 assert!(false);
5737         }
5738         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5739         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send less than their minimum HTLC value".to_string(), 1);
5740 }
5741
5742 #[test]
5743 fn test_update_add_htlc_bolt2_sender_zero_value_msat() {
5744         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5745         let chanmon_cfgs = create_chanmon_cfgs(2);
5746         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5747         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5748         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5749         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5750         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5751         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5752
5753         route.hops[0].fee_msat = 0;
5754
5755         let err = nodes[0].node.send_payment(route, our_payment_hash);
5756
5757         if let Err(APIError::ChannelUnavailable{err}) = err {
5758                 assert_eq!(err, "Cannot send 0-msat HTLC");
5759         } else {
5760                 assert!(false);
5761         }
5762         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5763         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send 0-msat HTLC".to_string(), 1);
5764 }
5765
5766 #[test]
5767 fn test_update_add_htlc_bolt2_receiver_zero_value_msat() {
5768         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5769         let chanmon_cfgs = create_chanmon_cfgs(2);
5770         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5771         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5772         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5773         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5774         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5775         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5776
5777         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5778         check_added_monitors!(nodes[0], 1);
5779         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5780         updates.update_add_htlcs[0].amount_msat = 0;
5781
5782         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5783         nodes[1].logger.assert_log("lightning::ln::channelmanager".to_string(), "Remote side tried to send a 0-msat HTLC".to_string(), 1);
5784         check_closed_broadcast!(nodes[1], true).unwrap();
5785         check_added_monitors!(nodes[1], 1);
5786 }
5787
5788 #[test]
5789 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5790         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5791         //It is enforced when constructing a route.
5792         let chanmon_cfgs = create_chanmon_cfgs(2);
5793         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5794         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5795         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5796         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, InitFeatures::supported(), InitFeatures::supported());
5797         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5798         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5799
5800         let err = nodes[0].node.send_payment(route, our_payment_hash);
5801
5802         if let Err(APIError::RouteError{err}) = err {
5803                 assert_eq!(err, "Channel CLTV overflowed?!");
5804         } else {
5805                 assert!(false);
5806         }
5807 }
5808
5809 #[test]
5810 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5811         //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.
5812         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5813         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5814         let chanmon_cfgs = create_chanmon_cfgs(2);
5815         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5816         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5817         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5818         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, InitFeatures::supported(), InitFeatures::supported());
5819         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5820
5821         for i in 0..max_accepted_htlcs {
5822                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5823                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5824                 let payment_event = {
5825                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5826                         check_added_monitors!(nodes[0], 1);
5827
5828                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5829                         assert_eq!(events.len(), 1);
5830                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5831                                 assert_eq!(htlcs[0].htlc_id, i);
5832                         } else {
5833                                 assert!(false);
5834                         }
5835                         SendEvent::from_event(events.remove(0))
5836                 };
5837                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
5838                 check_added_monitors!(nodes[1], 0);
5839                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5840
5841                 expect_pending_htlcs_forwardable!(nodes[1]);
5842                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5843         }
5844         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5845         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5846         let err = nodes[0].node.send_payment(route, our_payment_hash);
5847
5848         if let Err(APIError::ChannelUnavailable{err}) = err {
5849                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
5850         } else {
5851                 assert!(false);
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 push more than their max accepted HTLCs".to_string(), 1);
5855 }
5856
5857 #[test]
5858 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5859         //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.
5860         let chanmon_cfgs = create_chanmon_cfgs(2);
5861         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5862         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5863         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5864         let channel_value = 100000;
5865         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, InitFeatures::supported(), InitFeatures::supported());
5866         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5867
5868         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5869
5870         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5871         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5872         let err = nodes[0].node.send_payment(route, our_payment_hash);
5873
5874         if let Err(APIError::ChannelUnavailable{err}) = err {
5875                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept");
5876         } else {
5877                 assert!(false);
5878         }
5879         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5880         nodes[0].logger.assert_log("lightning::ln::channelmanager".to_string(), "Cannot send value that would put us over the max HTLC value in flight our peer will accept".to_string(), 1);
5881
5882         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5883 }
5884
5885 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5886 #[test]
5887 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5888         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5889         let chanmon_cfgs = create_chanmon_cfgs(2);
5890         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5891         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5892         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5893         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5894         let htlc_minimum_msat: u64;
5895         {
5896                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5897                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5898                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5899         }
5900         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5901         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5902         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5903         check_added_monitors!(nodes[0], 1);
5904         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5905         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5906         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5907         assert!(nodes[1].node.list_channels().is_empty());
5908         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5909         assert_eq!(err_msg.data, "Remote side tried to send less than our minimum HTLC value");
5910         check_added_monitors!(nodes[1], 1);
5911 }
5912
5913 #[test]
5914 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5915         //BOLT2 Requirement: receiving an amount_msat that the sending node cannot afford at the current feerate_per_kw (while maintaining its channel reserve): SHOULD fail the channel
5916         let chanmon_cfgs = create_chanmon_cfgs(2);
5917         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5918         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5919         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5920         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5921
5922         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5923
5924         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5925         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5926         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5927         check_added_monitors!(nodes[0], 1);
5928         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5929
5930         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5931         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5932
5933         assert!(nodes[1].node.list_channels().is_empty());
5934         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5935         assert_eq!(err_msg.data, "Remote HTLC add would put them over their reserve value");
5936         check_added_monitors!(nodes[1], 1);
5937 }
5938
5939 #[test]
5940 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5941         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5942         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5943         let chanmon_cfgs = create_chanmon_cfgs(2);
5944         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5945         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5946         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5947         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
5948         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5949         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5950
5951         let session_priv = SecretKey::from_slice(&{
5952                 let mut session_key = [0; 32];
5953                 let mut rng = thread_rng();
5954                 rng.fill_bytes(&mut session_key);
5955                 session_key
5956         }).expect("RNG is bad!");
5957
5958         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5959         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5960         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5961         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, [0; 32], &our_payment_hash);
5962
5963         let mut msg = msgs::UpdateAddHTLC {
5964                 channel_id: chan.2,
5965                 htlc_id: 0,
5966                 amount_msat: 1000,
5967                 payment_hash: our_payment_hash,
5968                 cltv_expiry: htlc_cltv,
5969                 onion_routing_packet: onion_packet.clone(),
5970         };
5971
5972         for i in 0..super::channel::OUR_MAX_HTLCS {
5973                 msg.htlc_id = i as u64;
5974                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5975         }
5976         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5977         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5978
5979         assert!(nodes[1].node.list_channels().is_empty());
5980         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
5981         assert_eq!(err_msg.data, "Remote tried to push more than our max accepted HTLCs");
5982         check_added_monitors!(nodes[1], 1);
5983 }
5984
5985 #[test]
5986 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5987         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5988         let chanmon_cfgs = create_chanmon_cfgs(2);
5989         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
5990         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
5991         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
5992         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
5993         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5994         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5995         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5996         check_added_monitors!(nodes[0], 1);
5997         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5998         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5999         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6000
6001         assert!(nodes[1].node.list_channels().is_empty());
6002         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6003         assert_eq!(err_msg.data,"Remote HTLC add would put them over our max HTLC value");
6004         check_added_monitors!(nodes[1], 1);
6005 }
6006
6007 #[test]
6008 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
6009         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
6010         let chanmon_cfgs = create_chanmon_cfgs(2);
6011         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6012         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6013         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6014         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, InitFeatures::supported(), InitFeatures::supported());
6015         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
6016         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6017         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6018         check_added_monitors!(nodes[0], 1);
6019         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6020         updates.update_add_htlcs[0].cltv_expiry = 500000000;
6021         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6022
6023         assert!(nodes[1].node.list_channels().is_empty());
6024         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6025         assert_eq!(err_msg.data,"Remote provided CLTV expiry in seconds instead of block height");
6026         check_added_monitors!(nodes[1], 1);
6027 }
6028
6029 #[test]
6030 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
6031         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
6032         // We test this by first testing that that repeated HTLCs pass commitment signature checks
6033         // after disconnect and that non-sequential htlc_ids result in a channel failure.
6034         let chanmon_cfgs = create_chanmon_cfgs(2);
6035         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6036         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6037         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6038         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6039         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6040         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6041         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6042         check_added_monitors!(nodes[0], 1);
6043         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6044         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6045
6046         //Disconnect and Reconnect
6047         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6048         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6049         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6050         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6051         assert_eq!(reestablish_1.len(), 1);
6052         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6053         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6054         assert_eq!(reestablish_2.len(), 1);
6055         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6056         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6057         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6058         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6059
6060         //Resend HTLC
6061         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6062         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
6063         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed);
6064         check_added_monitors!(nodes[1], 1);
6065         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6066
6067         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6068
6069         assert!(nodes[1].node.list_channels().is_empty());
6070         let err_msg = check_closed_broadcast!(nodes[1], true).unwrap();
6071         assert_eq!(err_msg.data, "Remote skipped HTLC ID");
6072         check_added_monitors!(nodes[1], 1);
6073 }
6074
6075 #[test]
6076 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
6077         //BOLT 2 Requirement: until the corresponding HTLC is irrevocably committed in both sides' commitment transactions:     MUST NOT send an update_fulfill_htlc, update_fail_htlc, or update_fail_malformed_htlc.
6078
6079         let chanmon_cfgs = create_chanmon_cfgs(2);
6080         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6081         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6082         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6083         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6084
6085         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6086         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6087         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6088         check_added_monitors!(nodes[0], 1);
6089         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6090         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6091
6092         let update_msg = msgs::UpdateFulfillHTLC{
6093                 channel_id: chan.2,
6094                 htlc_id: 0,
6095                 payment_preimage: our_payment_preimage,
6096         };
6097
6098         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6099
6100         assert!(nodes[0].node.list_channels().is_empty());
6101         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6102         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6103         check_added_monitors!(nodes[0], 1);
6104 }
6105
6106 #[test]
6107 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
6108         //BOLT 2 Requirement: until the corresponding HTLC is irrevocably committed in both sides' commitment transactions:     MUST NOT send an update_fulfill_htlc, update_fail_htlc, or update_fail_malformed_htlc.
6109
6110         let chanmon_cfgs = create_chanmon_cfgs(2);
6111         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6112         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6113         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6114         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6115
6116         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6117         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6118         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6119         check_added_monitors!(nodes[0], 1);
6120         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6121         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6122
6123         let update_msg = msgs::UpdateFailHTLC{
6124                 channel_id: chan.2,
6125                 htlc_id: 0,
6126                 reason: msgs::OnionErrorPacket { data: Vec::new()},
6127         };
6128
6129         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6130
6131         assert!(nodes[0].node.list_channels().is_empty());
6132         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6133         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6134         check_added_monitors!(nodes[0], 1);
6135 }
6136
6137 #[test]
6138 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
6139         //BOLT 2 Requirement: until the corresponding HTLC is irrevocably committed in both sides' commitment transactions:     MUST NOT send an update_fulfill_htlc, update_fail_htlc, or update_fail_malformed_htlc.
6140
6141         let chanmon_cfgs = create_chanmon_cfgs(2);
6142         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6143         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6144         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6145         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6146
6147         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6148         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6149         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6150         check_added_monitors!(nodes[0], 1);
6151         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6152         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6153
6154         let update_msg = msgs::UpdateFailMalformedHTLC{
6155                 channel_id: chan.2,
6156                 htlc_id: 0,
6157                 sha256_of_onion: [1; 32],
6158                 failure_code: 0x8000,
6159         };
6160
6161         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6162
6163         assert!(nodes[0].node.list_channels().is_empty());
6164         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6165         assert_eq!(err_msg.data, "Remote tried to fulfill/fail HTLC before it had been committed");
6166         check_added_monitors!(nodes[0], 1);
6167 }
6168
6169 #[test]
6170 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
6171         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
6172
6173         let chanmon_cfgs = create_chanmon_cfgs(2);
6174         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6175         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6176         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6177         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6178
6179         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6180
6181         nodes[1].node.claim_funds(our_payment_preimage, 100_000);
6182         check_added_monitors!(nodes[1], 1);
6183
6184         let events = nodes[1].node.get_and_clear_pending_msg_events();
6185         assert_eq!(events.len(), 1);
6186         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6187                 match events[0] {
6188                         MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
6189                                 assert!(update_add_htlcs.is_empty());
6190                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6191                                 assert!(update_fail_htlcs.is_empty());
6192                                 assert!(update_fail_malformed_htlcs.is_empty());
6193                                 assert!(update_fee.is_none());
6194                                 update_fulfill_htlcs[0].clone()
6195                         },
6196                         _ => panic!("Unexpected event"),
6197                 }
6198         };
6199
6200         update_fulfill_msg.htlc_id = 1;
6201
6202         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6203
6204         assert!(nodes[0].node.list_channels().is_empty());
6205         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6206         assert_eq!(err_msg.data, "Remote tried to fulfill/fail an HTLC we couldn't find");
6207         check_added_monitors!(nodes[0], 1);
6208 }
6209
6210 #[test]
6211 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
6212         //BOLT 2 Requirement: A receiving node: if the payment_preimage value in update_fulfill_htlc doesn't SHA256 hash to the corresponding HTLC payment_hash MUST fail the channel.
6213
6214         let chanmon_cfgs = create_chanmon_cfgs(2);
6215         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6216         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6217         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6218         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6219
6220         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
6221
6222         nodes[1].node.claim_funds(our_payment_preimage, 100_000);
6223         check_added_monitors!(nodes[1], 1);
6224
6225         let events = nodes[1].node.get_and_clear_pending_msg_events();
6226         assert_eq!(events.len(), 1);
6227         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
6228                 match events[0] {
6229                         MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
6230                                 assert!(update_add_htlcs.is_empty());
6231                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6232                                 assert!(update_fail_htlcs.is_empty());
6233                                 assert!(update_fail_malformed_htlcs.is_empty());
6234                                 assert!(update_fee.is_none());
6235                                 update_fulfill_htlcs[0].clone()
6236                         },
6237                         _ => panic!("Unexpected event"),
6238                 }
6239         };
6240
6241         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
6242
6243         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
6244
6245         assert!(nodes[0].node.list_channels().is_empty());
6246         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6247         assert_eq!(err_msg.data, "Remote tried to fulfill HTLC with an incorrect preimage");
6248         check_added_monitors!(nodes[0], 1);
6249 }
6250
6251 #[test]
6252 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
6253         //BOLT 2 Requirement: A receiving node: if the BADONION bit in failure_code is not set for update_fail_malformed_htlc MUST fail the channel.
6254
6255         let chanmon_cfgs = create_chanmon_cfgs(2);
6256         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6257         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6258         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6259         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6260         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
6261         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6262         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6263         check_added_monitors!(nodes[0], 1);
6264
6265         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6266         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6267
6268         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
6269         check_added_monitors!(nodes[1], 0);
6270         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
6271
6272         let events = nodes[1].node.get_and_clear_pending_msg_events();
6273
6274         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
6275                 match events[0] {
6276                         MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
6277                                 assert!(update_add_htlcs.is_empty());
6278                                 assert!(update_fulfill_htlcs.is_empty());
6279                                 assert!(update_fail_htlcs.is_empty());
6280                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6281                                 assert!(update_fee.is_none());
6282                                 update_fail_malformed_htlcs[0].clone()
6283                         },
6284                         _ => panic!("Unexpected event"),
6285                 }
6286         };
6287         update_msg.failure_code &= !0x8000;
6288         nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
6289
6290         assert!(nodes[0].node.list_channels().is_empty());
6291         let err_msg = check_closed_broadcast!(nodes[0], true).unwrap();
6292         assert_eq!(err_msg.data, "Got update_fail_malformed_htlc with BADONION not set");
6293         check_added_monitors!(nodes[0], 1);
6294 }
6295
6296 #[test]
6297 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
6298         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
6299         //    * MUST return an error in the update_fail_htlc sent to the link which originally sent the HTLC, using the failure_code given and setting the data to sha256_of_onion.
6300
6301         let chanmon_cfgs = create_chanmon_cfgs(3);
6302         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6303         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6304         let mut nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6305         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6306         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6307
6308         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
6309         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6310
6311         //First hop
6312         let mut payment_event = {
6313                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6314                 check_added_monitors!(nodes[0], 1);
6315                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6316                 assert_eq!(events.len(), 1);
6317                 SendEvent::from_event(events.remove(0))
6318         };
6319         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]);
6320         check_added_monitors!(nodes[1], 0);
6321         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6322         expect_pending_htlcs_forwardable!(nodes[1]);
6323         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6324         assert_eq!(events_2.len(), 1);
6325         check_added_monitors!(nodes[1], 1);
6326         payment_event = SendEvent::from_event(events_2.remove(0));
6327         assert_eq!(payment_event.msgs.len(), 1);
6328
6329         //Second Hop
6330         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
6331         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]);
6332         check_added_monitors!(nodes[2], 0);
6333         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
6334
6335         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6336         assert_eq!(events_3.len(), 1);
6337         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
6338                 match events_3[0] {
6339                         MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
6340                                 assert!(update_add_htlcs.is_empty());
6341                                 assert!(update_fulfill_htlcs.is_empty());
6342                                 assert!(update_fail_htlcs.is_empty());
6343                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
6344                                 assert!(update_fee.is_none());
6345                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
6346                         },
6347                         _ => panic!("Unexpected event"),
6348                 }
6349         };
6350
6351         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0);
6352
6353         check_added_monitors!(nodes[1], 0);
6354         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
6355         expect_pending_htlcs_forwardable!(nodes[1]);
6356         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6357         assert_eq!(events_4.len(), 1);
6358
6359         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
6360         match events_4[0] {
6361                 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, .. } } => {
6362                         assert!(update_add_htlcs.is_empty());
6363                         assert!(update_fulfill_htlcs.is_empty());
6364                         assert_eq!(update_fail_htlcs.len(), 1);
6365                         assert!(update_fail_malformed_htlcs.is_empty());
6366                         assert!(update_fee.is_none());
6367                 },
6368                 _ => panic!("Unexpected event"),
6369         };
6370
6371         check_added_monitors!(nodes[1], 1);
6372 }
6373
6374 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
6375         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
6376         // We can have at most two valid local commitment tx, so both cases must be covered, and both txs must be checked to get them all as
6377         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
6378
6379         let chanmon_cfgs = create_chanmon_cfgs(2);
6380         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6381         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6382         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6383         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6384
6385         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6386
6387         // We route 2 dust-HTLCs between A and B
6388         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6389         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6390         route_payment(&nodes[0], &[&nodes[1]], 1000000);
6391
6392         // Cache one local commitment tx as previous
6393         let as_prev_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6394
6395         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
6396         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
6397         check_added_monitors!(nodes[1], 0);
6398         expect_pending_htlcs_forwardable!(nodes[1]);
6399         check_added_monitors!(nodes[1], 1);
6400
6401         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6402         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]);
6403         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed);
6404         check_added_monitors!(nodes[0], 1);
6405
6406         // Cache one local commitment tx as lastest
6407         let as_last_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6408
6409         let events = nodes[0].node.get_and_clear_pending_msg_events();
6410         match events[0] {
6411                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
6412                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6413                 },
6414                 _ => panic!("Unexpected event"),
6415         }
6416         match events[1] {
6417                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
6418                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
6419                 },
6420                 _ => panic!("Unexpected event"),
6421         }
6422
6423         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
6424         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
6425         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6426
6427         if announce_latest {
6428                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
6429         } else {
6430                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
6431         }
6432
6433         check_closed_broadcast!(nodes[0], false);
6434         check_added_monitors!(nodes[0], 1);
6435
6436         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6437         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
6438         let events = nodes[0].node.get_and_clear_pending_events();
6439         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
6440         assert_eq!(events.len(), 2);
6441         let mut first_failed = false;
6442         for event in events {
6443                 match event {
6444                         Event::PaymentFailed { payment_hash, .. } => {
6445                                 if payment_hash == payment_hash_1 {
6446                                         assert!(!first_failed);
6447                                         first_failed = true;
6448                                 } else {
6449                                         assert_eq!(payment_hash, payment_hash_2);
6450                                 }
6451                         }
6452                         _ => panic!("Unexpected event"),
6453                 }
6454         }
6455 }
6456
6457 #[test]
6458 fn test_failure_delay_dust_htlc_local_commitment() {
6459         do_test_failure_delay_dust_htlc_local_commitment(true);
6460         do_test_failure_delay_dust_htlc_local_commitment(false);
6461 }
6462
6463 #[test]
6464 fn test_no_failure_dust_htlc_local_commitment() {
6465         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
6466         // prone to error, we test here that a dummy transaction don't fail them.
6467
6468         let chanmon_cfgs = create_chanmon_cfgs(2);
6469         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6470         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6471         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6472         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6473
6474         // Rebalance a bit
6475         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6476
6477         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6478         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6479
6480         // We route 2 dust-HTLCs between A and B
6481         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6482         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
6483
6484         // Build a dummy invalid transaction trying to spend a commitment tx
6485         let input = TxIn {
6486                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
6487                 script_sig: Script::new(),
6488                 sequence: 0,
6489                 witness: Vec::new(),
6490         };
6491
6492         let outp = TxOut {
6493                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
6494                 value: 10000,
6495         };
6496
6497         let dummy_tx = Transaction {
6498                 version: 2,
6499                 lock_time: 0,
6500                 input: vec![input],
6501                 output: vec![outp]
6502         };
6503
6504         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6505         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
6506         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6507         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6508         // We broadcast a few more block to check everything is all right
6509         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
6510         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6511         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
6512
6513         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
6514         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
6515 }
6516
6517 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
6518         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
6519         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
6520         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
6521         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
6522         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
6523         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
6524
6525         let chanmon_cfgs = create_chanmon_cfgs(3);
6526         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6527         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &[None, None, None]);
6528         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6529         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6530
6531         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
6532
6533         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
6534         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6535
6536         let as_commitment_tx = get_local_commitment_txn!(nodes[0], chan.2);
6537         let bs_commitment_tx = get_local_commitment_txn!(nodes[1], chan.2);
6538
6539         // We revoked bs_commitment_tx
6540         if revoked {
6541                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6542                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
6543         }
6544
6545         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6546         let mut timeout_tx = Vec::new();
6547         if local {
6548                 // We fail dust-HTLC 1 by broadcast of local commitment tx
6549                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
6550                 check_closed_broadcast!(nodes[0], false);
6551                 check_added_monitors!(nodes[0], 1);
6552                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6553                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6554                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6555                 let events = nodes[0].node.get_and_clear_pending_events();
6556                 assert_eq!(events.len(), 1);
6557                 match events[0] {
6558                         Event::PaymentFailed { payment_hash, .. } => {
6559                                 assert_eq!(payment_hash, dust_hash);
6560                         },
6561                         _ => panic!("Unexpected event"),
6562                 }
6563                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
6564                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
6565                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6566                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6567                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6568                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6569                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6570                 let events = nodes[0].node.get_and_clear_pending_events();
6571                 assert_eq!(events.len(), 1);
6572                 match events[0] {
6573                         Event::PaymentFailed { payment_hash, .. } => {
6574                                 assert_eq!(payment_hash, non_dust_hash);
6575                         },
6576                         _ => panic!("Unexpected event"),
6577                 }
6578         } else {
6579                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
6580                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
6581                 check_closed_broadcast!(nodes[0], false);
6582                 check_added_monitors!(nodes[0], 1);
6583                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6584                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
6585                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
6586                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6587                 if !revoked {
6588                         let events = nodes[0].node.get_and_clear_pending_events();
6589                         assert_eq!(events.len(), 1);
6590                         match events[0] {
6591                                 Event::PaymentFailed { payment_hash, .. } => {
6592                                         assert_eq!(payment_hash, dust_hash);
6593                                 },
6594                                 _ => panic!("Unexpected event"),
6595                         }
6596                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
6597                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
6598                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
6599                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
6600                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6601                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
6602                         let events = nodes[0].node.get_and_clear_pending_events();
6603                         assert_eq!(events.len(), 1);
6604                         match events[0] {
6605                                 Event::PaymentFailed { payment_hash, .. } => {
6606                                         assert_eq!(payment_hash, non_dust_hash);
6607                                 },
6608                                 _ => panic!("Unexpected event"),
6609                         }
6610                 } else {
6611                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
6612                         // commitment tx
6613                         let events = nodes[0].node.get_and_clear_pending_events();
6614                         assert_eq!(events.len(), 2);
6615                         let first;
6616                         match events[0] {
6617                                 Event::PaymentFailed { payment_hash, .. } => {
6618                                         if payment_hash == dust_hash { first = true; }
6619                                         else { first = false; }
6620                                 },
6621                                 _ => panic!("Unexpected event"),
6622                         }
6623                         match events[1] {
6624                                 Event::PaymentFailed { payment_hash, .. } => {
6625                                         if first { assert_eq!(payment_hash, non_dust_hash); }
6626                                         else { assert_eq!(payment_hash, dust_hash); }
6627                                 },
6628                                 _ => panic!("Unexpected event"),
6629                         }
6630                 }
6631         }
6632 }
6633
6634 #[test]
6635 fn test_sweep_outbound_htlc_failure_update() {
6636         do_test_sweep_outbound_htlc_failure_update(false, true);
6637         do_test_sweep_outbound_htlc_failure_update(false, false);
6638         do_test_sweep_outbound_htlc_failure_update(true, false);
6639 }
6640
6641 #[test]
6642 fn test_upfront_shutdown_script() {
6643         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
6644         // enforce it at shutdown message
6645
6646         let mut config = UserConfig::default();
6647         config.channel_options.announced_channel = true;
6648         config.peer_channel_config_limits.force_announced_channel_preference = false;
6649         config.channel_options.commit_upfront_shutdown_pubkey = false;
6650         let user_cfgs = [None, Some(config), None];
6651         let chanmon_cfgs = create_chanmon_cfgs(3);
6652         let node_cfgs = create_node_cfgs(3, &chanmon_cfgs);
6653         let node_chanmgrs = create_node_chanmgrs(3, &node_cfgs, &user_cfgs);
6654         let nodes = create_network(3, &node_cfgs, &node_chanmgrs);
6655
6656         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
6657         let flags = InitFeatures::supported();
6658         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6659         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6660         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6661         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6662         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
6663         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6664         assert_eq!(check_closed_broadcast!(nodes[2], true).unwrap().data, "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
6665         check_added_monitors!(nodes[2], 1);
6666
6667         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
6668         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
6669         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6670         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
6671         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
6672         nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown);
6673         let events = nodes[2].node.get_and_clear_pending_msg_events();
6674         assert_eq!(events.len(), 1);
6675         match events[0] {
6676                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6677                 _ => panic!("Unexpected event"),
6678         }
6679
6680         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
6681         let mut flags_no = InitFeatures::supported();
6682         flags_no.unset_upfront_shutdown_script();
6683         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
6684         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6685         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6686         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6687         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown);
6688         let events = nodes[1].node.get_and_clear_pending_msg_events();
6689         assert_eq!(events.len(), 1);
6690         match events[0] {
6691                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6692                 _ => panic!("Unexpected event"),
6693         }
6694
6695         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6696         // channel smoothly, opt-out is from channel initiator here
6697         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6698         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6699         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6700         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6701         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6702         let events = nodes[0].node.get_and_clear_pending_msg_events();
6703         assert_eq!(events.len(), 1);
6704         match events[0] {
6705                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6706                 _ => panic!("Unexpected event"),
6707         }
6708
6709         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6710         //// channel smoothly
6711         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6712         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6713         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6714         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6715         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown);
6716         let events = nodes[0].node.get_and_clear_pending_msg_events();
6717         assert_eq!(events.len(), 2);
6718         match events[0] {
6719                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6720                 _ => panic!("Unexpected event"),
6721         }
6722         match events[1] {
6723                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6724                 _ => panic!("Unexpected event"),
6725         }
6726 }
6727
6728 #[test]
6729 fn test_user_configurable_csv_delay() {
6730         // We test our channel constructors yield errors when we pass them absurd csv delay
6731
6732         let mut low_our_to_self_config = UserConfig::default();
6733         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6734         let mut high_their_to_self_config = UserConfig::default();
6735         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6736         let user_cfgs = [Some(high_their_to_self_config.clone()), None];
6737         let chanmon_cfgs = create_chanmon_cfgs(2);
6738         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6739         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &user_cfgs);
6740         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6741
6742         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6743         let keys_manager: Arc<KeysInterface<ChanKeySigner = EnforcingChannelKeys>> = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
6744         if let Err(error) = Channel::new_outbound(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), 1000000, 1000000, 0, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6745                 match error {
6746                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6747                         _ => panic!("Unexpected event"),
6748                 }
6749         } else { assert!(false) }
6750
6751         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6752         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6753         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6754         open_channel.to_self_delay = 200;
6755         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6756                 match error {
6757                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6758                         _ => panic!("Unexpected event"),
6759                 }
6760         } else { assert!(false); }
6761
6762         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6763         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6764         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id()));
6765         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6766         accept_channel.to_self_delay = 200;
6767         nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), InitFeatures::supported(), &accept_channel);
6768         if let MessageSendEvent::HandleError { ref action, .. } = nodes[0].node.get_and_clear_pending_msg_events()[0] {
6769                 match action {
6770                         &ErrorAction::SendErrorMessage { ref msg } => {
6771                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6772                         },
6773                         _ => { assert!(false); }
6774                 }
6775         } else { assert!(false); }
6776
6777         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6778         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42, None).unwrap();
6779         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6780         open_channel.to_self_delay = 200;
6781         if let Err(error) = Channel::new_from_req(&&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), InitFeatures::supported(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &high_their_to_self_config) {
6782                 match error {
6783                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6784                         _ => panic!("Unexpected event"),
6785                 }
6786         } else { assert!(false); }
6787 }
6788
6789 #[test]
6790 fn test_data_loss_protect() {
6791         // We want to be sure that :
6792         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6793         // * we close channel in case of detecting other being fallen behind
6794         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6795         let keys_manager;
6796         let fee_estimator;
6797         let tx_broadcaster;
6798         let monitor;
6799         let node_state_0;
6800         let chanmon_cfgs = create_chanmon_cfgs(2);
6801         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6802         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6803         let mut nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6804
6805         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, InitFeatures::supported(), InitFeatures::supported());
6806
6807         // Cache node A state before any channel update
6808         let previous_node_state = nodes[0].node.encode();
6809         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6810         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6811
6812         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6813         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6814
6815         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6816         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6817
6818         // Restore node A from previous state
6819         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6820         let mut chan_monitor = <(Sha256dHash, ChannelMonitor<EnforcingChannelKeys>)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6821         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6822         tx_broadcaster = test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())};
6823         fee_estimator = test_utils::TestFeeEstimator { sat_per_kw: 253 };
6824         keys_manager = test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger));
6825         monitor = test_utils::TestChannelMonitor::new(chain_monitor.clone(), &tx_broadcaster, logger.clone(), &fee_estimator);
6826         node_state_0 = {
6827                 let mut channel_monitors = HashMap::new();
6828                 channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &mut chan_monitor);
6829                 <(Sha256dHash, ChannelManager<EnforcingChannelKeys, &test_utils::TestChannelMonitor, &test_utils::TestBroadcaster, &test_utils::TestKeysInterface, &test_utils::TestFeeEstimator>)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6830                         keys_manager: &keys_manager,
6831                         fee_estimator: &fee_estimator,
6832                         monitor: &monitor,
6833                         logger: Arc::clone(&logger),
6834                         tx_broadcaster: &tx_broadcaster,
6835                         default_config: UserConfig::default(),
6836                         channel_monitors: &mut channel_monitors,
6837                 }).unwrap().1
6838         };
6839         nodes[0].node = &node_state_0;
6840         assert!(monitor.add_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor).is_ok());
6841         nodes[0].chan_monitor = &monitor;
6842         nodes[0].chain_monitor = chain_monitor;
6843
6844         nodes[0].block_notifier = BlockNotifier::new(nodes[0].chain_monitor.clone());
6845         nodes[0].block_notifier.register_listener(&nodes[0].chan_monitor.simple_monitor);
6846         nodes[0].block_notifier.register_listener(nodes[0].node);
6847
6848         check_added_monitors!(nodes[0], 1);
6849
6850         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6851         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6852
6853         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6854
6855         // Check we update monitor following learning of per_commitment_point from B
6856         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0]);
6857         check_added_monitors!(nodes[0], 2);
6858
6859         {
6860                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6861                 assert_eq!(node_txn.len(), 0);
6862         }
6863
6864         let mut reestablish_1 = Vec::with_capacity(1);
6865         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6866                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6867                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6868                         reestablish_1.push(msg.clone());
6869                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6870                 } else if let MessageSendEvent::HandleError { ref action, .. } = msg {
6871                         match action {
6872                                 &ErrorAction::SendErrorMessage { ref msg } => {
6873                                         assert_eq!(msg.data, "We have fallen behind - we have received proof that if we broadcast remote is going to claim our funds - we can't do any automated broadcasting");
6874                                 },
6875                                 _ => panic!("Unexpected event!"),
6876                         }
6877                 } else {
6878                         panic!("Unexpected event")
6879                 }
6880         }
6881
6882         // Check we close channel detecting A is fallen-behind
6883         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6884         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Peer attempted to reestablish channel with a very old local commitment transaction");
6885         check_added_monitors!(nodes[1], 1);
6886
6887
6888         // Check A is able to claim to_remote output
6889         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6890         assert_eq!(node_txn.len(), 1);
6891         check_spends!(node_txn[0], chan.3);
6892         assert_eq!(node_txn[0].output.len(), 2);
6893         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6894         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 0);
6895         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 0, true, header.bitcoin_hash());
6896         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6897         assert_eq!(spend_txn.len(), 1);
6898         check_spends!(spend_txn[0], node_txn[0]);
6899 }
6900
6901 #[test]
6902 fn test_check_htlc_underpaying() {
6903         // Send payment through A -> B but A is maliciously
6904         // sending a probe payment (i.e less than expected value0
6905         // to B, B should refuse payment.
6906
6907         let chanmon_cfgs = create_chanmon_cfgs(2);
6908         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6909         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6910         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6911
6912         // Create some initial channels
6913         create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported());
6914
6915         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6916
6917         // Node 3 is expecting payment of 100_000 but receive 10_000,
6918         // fail htlc like we didn't know the preimage.
6919         nodes[1].node.claim_funds(payment_preimage, 100_000);
6920         nodes[1].node.process_pending_htlc_forwards();
6921
6922         let events = nodes[1].node.get_and_clear_pending_msg_events();
6923         assert_eq!(events.len(), 1);
6924         let (update_fail_htlc, commitment_signed) = match events[0] {
6925                 MessageSendEvent::UpdateHTLCs { node_id: _ , updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
6926                         assert!(update_add_htlcs.is_empty());
6927                         assert!(update_fulfill_htlcs.is_empty());
6928                         assert_eq!(update_fail_htlcs.len(), 1);
6929                         assert!(update_fail_malformed_htlcs.is_empty());
6930                         assert!(update_fee.is_none());
6931                         (update_fail_htlcs[0].clone(), commitment_signed)
6932                 },
6933                 _ => panic!("Unexpected event"),
6934         };
6935         check_added_monitors!(nodes[1], 1);
6936
6937         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc);
6938         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6939
6940         let events = nodes[0].node.get_and_clear_pending_events();
6941         assert_eq!(events.len(), 1);
6942         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6943                 assert_eq!(*rejected_by_dest, true);
6944                 assert_eq!(error_code.unwrap(), 0x4000|15);
6945         } else {
6946                 panic!("Unexpected event");
6947         }
6948         nodes[1].node.get_and_clear_pending_events();
6949 }
6950
6951 #[test]
6952 fn test_announce_disable_channels() {
6953         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6954         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6955
6956         let chanmon_cfgs = create_chanmon_cfgs(2);
6957         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
6958         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
6959         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
6960
6961         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6962         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6963         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).0.contents.short_channel_id;
6964
6965         // Disconnect peers
6966         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6967         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6968
6969         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6970         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6971         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6972         assert_eq!(msg_events.len(), 3);
6973         for e in msg_events {
6974                 match e {
6975                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6976                                 let short_id = msg.contents.short_channel_id;
6977                                 // Check generated channel_update match list in PendingChannelUpdate
6978                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6979                                         panic!("Generated ChannelUpdate for wrong chan!");
6980                                 }
6981                         },
6982                         _ => panic!("Unexpected event"),
6983                 }
6984         }
6985         // Reconnect peers
6986         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6987         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6988         assert_eq!(reestablish_1.len(), 3);
6989         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id(), &msgs::Init { features: InitFeatures::empty() });
6990         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6991         assert_eq!(reestablish_2.len(), 3);
6992
6993         // Reestablish chan_1
6994         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]);
6995         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6996         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]);
6997         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6998         // Reestablish chan_2
6999         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]);
7000         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7001         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]);
7002         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7003         // Reestablish chan_3
7004         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]);
7005         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7006         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]);
7007         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7008
7009         nodes[0].node.timer_chan_freshness_every_min();
7010         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7011 }
7012
7013 #[test]
7014 fn test_bump_penalty_txn_on_revoked_commitment() {
7015         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to be sure
7016         // we're able to claim outputs on revoked commitment transaction before timelocks expiration
7017
7018         let chanmon_cfgs = create_chanmon_cfgs(2);
7019         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7020         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7021         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7022
7023         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7024         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7025         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 3000000, 30).unwrap();
7026         send_along_route(&nodes[1], route, &vec!(&nodes[0])[..], 3000000);
7027
7028         let revoked_txn = get_local_commitment_txn!(nodes[0], chan.2);
7029         // Revoked commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7030         assert_eq!(revoked_txn[0].output.len(), 4);
7031         assert_eq!(revoked_txn[0].input.len(), 1);
7032         assert_eq!(revoked_txn[0].input[0].previous_output.txid, chan.3.txid());
7033         let revoked_txid = revoked_txn[0].txid();
7034
7035         let mut penalty_sum = 0;
7036         for outp in revoked_txn[0].output.iter() {
7037                 if outp.script_pubkey.is_v0_p2wsh() {
7038                         penalty_sum += outp.value;
7039                 }
7040         }
7041
7042         // Connect blocks to change height_timer range to see if we use right soonest_timelock
7043         let header_114 = connect_blocks(&nodes[1].block_notifier, 114, 0, false, Default::default());
7044
7045         // Actually revoke tx by claiming a HTLC
7046         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7047         let header = BlockHeader { version: 0x20000000, prev_blockhash: header_114, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7048         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_txn[0].clone()] }, 115);
7049         check_added_monitors!(nodes[1], 1);
7050
7051         // One or more justice tx should have been broadcast, check it
7052         let penalty_1;
7053         let feerate_1;
7054         {
7055                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7056                 assert_eq!(node_txn.len(), 3); // justice tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout (broadcasted from ChannelManager)
7057                 assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7058                 assert_eq!(node_txn[0].output.len(), 1);
7059                 check_spends!(node_txn[0], revoked_txn[0]);
7060                 let fee_1 = penalty_sum - node_txn[0].output[0].value;
7061                 feerate_1 = fee_1 * 1000 / node_txn[0].get_weight() as u64;
7062                 penalty_1 = node_txn[0].txid();
7063                 node_txn.clear();
7064         };
7065
7066         // After exhaustion of height timer, a new bumped justice tx should have been broadcast, check it
7067         let header = connect_blocks(&nodes[1].block_notifier, 3, 115,  true, header.bitcoin_hash());
7068         let mut penalty_2 = penalty_1;
7069         let mut feerate_2 = 0;
7070         {
7071                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7072                 assert_eq!(node_txn.len(), 1);
7073                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7074                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7075                         assert_eq!(node_txn[0].output.len(), 1);
7076                         check_spends!(node_txn[0], revoked_txn[0]);
7077                         penalty_2 = node_txn[0].txid();
7078                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7079                         assert_ne!(penalty_2, penalty_1);
7080                         let fee_2 = penalty_sum - node_txn[0].output[0].value;
7081                         feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7082                         // Verify 25% bump heuristic
7083                         assert!(feerate_2 * 100 >= feerate_1 * 125);
7084                         node_txn.clear();
7085                 }
7086         }
7087         assert_ne!(feerate_2, 0);
7088
7089         // After exhaustion of height timer for a 2nd time, a new bumped justice tx should have been broadcast, check it
7090         connect_blocks(&nodes[1].block_notifier, 3, 118, true, header);
7091         let penalty_3;
7092         let mut feerate_3 = 0;
7093         {
7094                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7095                 assert_eq!(node_txn.len(), 1);
7096                 if node_txn[0].input[0].previous_output.txid == revoked_txid {
7097                         assert_eq!(node_txn[0].input.len(), 3); // Penalty txn claims to_local, offered_htlc and received_htlc outputs
7098                         assert_eq!(node_txn[0].output.len(), 1);
7099                         check_spends!(node_txn[0], revoked_txn[0]);
7100                         penalty_3 = node_txn[0].txid();
7101                         // Verify new bumped tx is different from last claiming transaction, we don't want spurrious rebroadcast
7102                         assert_ne!(penalty_3, penalty_2);
7103                         let fee_3 = penalty_sum - node_txn[0].output[0].value;
7104                         feerate_3 = fee_3 * 1000 / node_txn[0].get_weight() as u64;
7105                         // Verify 25% bump heuristic
7106                         assert!(feerate_3 * 100 >= feerate_2 * 125);
7107                         node_txn.clear();
7108                 }
7109         }
7110         assert_ne!(feerate_3, 0);
7111
7112         nodes[1].node.get_and_clear_pending_events();
7113         nodes[1].node.get_and_clear_pending_msg_events();
7114 }
7115
7116 #[test]
7117 fn test_bump_penalty_txn_on_revoked_htlcs() {
7118         // In case of penalty txn with too low feerates for getting into mempools, RBF-bump them to sure
7119         // we're able to claim outputs on revoked HTLC transactions before timelocks expiration
7120
7121         let chanmon_cfgs = create_chanmon_cfgs(2);
7122         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7123         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7124         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7125
7126         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7127         // Lock HTLC in both directions
7128         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3_000_000).0;
7129         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7130
7131         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7132         assert_eq!(revoked_local_txn[0].input.len(), 1);
7133         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7134
7135         // Revoke local commitment tx
7136         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
7137
7138         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7139         // B will generate both revoked HTLC-timeout/HTLC-preimage txn from revoked commitment tx
7140         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
7141         check_closed_broadcast!(nodes[1], false);
7142         check_added_monitors!(nodes[1], 1);
7143
7144         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7145         assert_eq!(revoked_htlc_txn.len(), 6);
7146         if revoked_htlc_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7147                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7148                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7149                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7150                 assert_eq!(revoked_htlc_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7151                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7152         } else if revoked_htlc_txn[1].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7153                 assert_eq!(revoked_htlc_txn[1].input.len(), 1);
7154                 check_spends!(revoked_htlc_txn[1], revoked_local_txn[0]);
7155                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
7156                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
7157                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0]);
7158         }
7159
7160         // Broadcast set of revoked txn on A
7161         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0, true, header.bitcoin_hash());
7162         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7163         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone(), revoked_htlc_txn[1].clone()] }, 129);
7164         let first;
7165         let feerate_1;
7166         let penalty_txn;
7167         {
7168                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7169                 assert_eq!(node_txn.len(), 5); // 3 penalty txn on revoked commitment tx + A commitment tx + 1 penalty tnx on revoked HTLC txn
7170                 // Verify claim tx are spending revoked HTLC txn
7171                 assert_eq!(node_txn[4].input.len(), 2);
7172                 assert_eq!(node_txn[4].output.len(), 1);
7173                 check_spends!(node_txn[4], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7174                 first = node_txn[4].txid();
7175                 // Store both feerates for later comparison
7176                 let fee_1 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[4].output[0].value;
7177                 feerate_1 = fee_1 * 1000 / node_txn[4].get_weight() as u64;
7178                 penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7179                 node_txn.clear();
7180         }
7181
7182         // Connect three more block to see if bumped penalty are issued for HTLC txn
7183         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7184         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7185         {
7186                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7187                 assert_eq!(node_txn.len(), 2); // 2 bumped penalty txn on revoked commitment tx
7188
7189                 check_spends!(node_txn[0], revoked_local_txn[0]);
7190                 check_spends!(node_txn[1], revoked_local_txn[0]);
7191
7192                 node_txn.clear();
7193         };
7194
7195         // Few more blocks to confirm penalty txn
7196         let header_135 = connect_blocks(&nodes[0].block_notifier, 5, 130, true, header_130.bitcoin_hash());
7197         assert!(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().is_empty());
7198         let header_144 = connect_blocks(&nodes[0].block_notifier, 9, 135, true, header_135);
7199         let node_txn = {
7200                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7201                 assert_eq!(node_txn.len(), 1);
7202
7203                 assert_eq!(node_txn[0].input.len(), 2);
7204                 check_spends!(node_txn[0], revoked_htlc_txn[0], revoked_htlc_txn[1]);
7205                 // Verify bumped tx is different and 25% bump heuristic
7206                 assert_ne!(first, node_txn[0].txid());
7207                 let fee_2 = revoked_htlc_txn[0].output[0].value + revoked_htlc_txn[1].output[0].value - node_txn[0].output[0].value;
7208                 let feerate_2 = fee_2 * 1000 / node_txn[0].get_weight() as u64;
7209                 assert!(feerate_2 * 100 > feerate_1 * 125);
7210                 let txn = vec![node_txn[0].clone()];
7211                 node_txn.clear();
7212                 txn
7213         };
7214         // Broadcast claim txn and confirm blocks to avoid further bumps on this outputs
7215         let header_145 = BlockHeader { version: 0x20000000, prev_blockhash: header_144, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7216         nodes[0].block_notifier.block_connected(&Block { header: header_145, txdata: node_txn }, 145);
7217         connect_blocks(&nodes[0].block_notifier, 20, 145, true, header_145.bitcoin_hash());
7218         {
7219                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7220                 // We verify than no new transaction has been broadcast because previously
7221                 // we were buggy on this exact behavior by not tracking for monitoring remote HTLC outputs (see #411)
7222                 // which means we wouldn't see a spend of them by a justice tx and bumped justice tx
7223                 // were generated forever instead of safe cleaning after confirmation and ANTI_REORG_SAFE_DELAY blocks.
7224                 // Enforce spending of revoked htlc output by claiming transaction remove request as expected and dry
7225                 // up bumped justice generation.
7226                 assert_eq!(node_txn.len(), 0);
7227                 node_txn.clear();
7228         }
7229         check_closed_broadcast!(nodes[0], false);
7230         check_added_monitors!(nodes[0], 1);
7231 }
7232
7233 #[test]
7234 fn test_bump_penalty_txn_on_remote_commitment() {
7235         // In case of claim txn with too low feerates for getting into mempools, RBF-bump them to be sure
7236         // we're able to claim outputs on remote commitment transaction before timelocks expiration
7237
7238         // Create 2 HTLCs
7239         // Provide preimage for one
7240         // Check aggregation
7241
7242         let chanmon_cfgs = create_chanmon_cfgs(2);
7243         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7244         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7245         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7246
7247         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7248         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
7249         route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
7250
7251         // Remote commitment txn with 4 outputs : to_local, to_remote, 1 outgoing HTLC, 1 incoming HTLC
7252         let remote_txn = get_local_commitment_txn!(nodes[0], chan.2);
7253         assert_eq!(remote_txn[0].output.len(), 4);
7254         assert_eq!(remote_txn[0].input.len(), 1);
7255         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7256
7257         // Claim a HTLC without revocation (provide B monitor with preimage)
7258         nodes[1].node.claim_funds(payment_preimage, 3_000_000);
7259         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7260         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
7261         check_added_monitors!(nodes[1], 2);
7262
7263         // One or more claim tx should have been broadcast, check it
7264         let timeout;
7265         let preimage;
7266         let feerate_timeout;
7267         let feerate_preimage;
7268         {
7269                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7270                 assert_eq!(node_txn.len(), 5); // 2 * claim tx (broadcasted from ChannelMonitor) + local commitment tx + local HTLC-timeout + local HTLC-success (broadcasted from ChannelManager)
7271                 assert_eq!(node_txn[0].input.len(), 1);
7272                 assert_eq!(node_txn[1].input.len(), 1);
7273                 check_spends!(node_txn[0], remote_txn[0]);
7274                 check_spends!(node_txn[1], remote_txn[0]);
7275                 check_spends!(node_txn[2], chan.3);
7276                 check_spends!(node_txn[3], node_txn[2]);
7277                 check_spends!(node_txn[4], node_txn[2]);
7278                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7279                         timeout = node_txn[0].txid();
7280                         let index = node_txn[0].input[0].previous_output.vout;
7281                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7282                         feerate_timeout = fee * 1000 / node_txn[0].get_weight() as u64;
7283
7284                         preimage = node_txn[1].txid();
7285                         let index = node_txn[1].input[0].previous_output.vout;
7286                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7287                         feerate_preimage = fee * 1000 / node_txn[1].get_weight() as u64;
7288                 } else {
7289                         timeout = node_txn[1].txid();
7290                         let index = node_txn[1].input[0].previous_output.vout;
7291                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7292                         feerate_timeout = fee * 1000 / node_txn[1].get_weight() as u64;
7293
7294                         preimage = node_txn[0].txid();
7295                         let index = node_txn[0].input[0].previous_output.vout;
7296                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7297                         feerate_preimage = fee * 1000 / node_txn[0].get_weight() as u64;
7298                 }
7299                 node_txn.clear();
7300         };
7301         assert_ne!(feerate_timeout, 0);
7302         assert_ne!(feerate_preimage, 0);
7303
7304         // After exhaustion of height timer, new bumped claim txn should have been broadcast, check it
7305         connect_blocks(&nodes[1].block_notifier, 15, 1,  true, header.bitcoin_hash());
7306         {
7307                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7308                 assert_eq!(node_txn.len(), 2);
7309                 assert_eq!(node_txn[0].input.len(), 1);
7310                 assert_eq!(node_txn[1].input.len(), 1);
7311                 check_spends!(node_txn[0], remote_txn[0]);
7312                 check_spends!(node_txn[1], remote_txn[0]);
7313                 if node_txn[0].input[0].witness.last().unwrap().len() == ACCEPTED_HTLC_SCRIPT_WEIGHT {
7314                         let index = node_txn[0].input[0].previous_output.vout;
7315                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7316                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7317                         assert!(new_feerate * 100 > feerate_timeout * 125);
7318                         assert_ne!(timeout, node_txn[0].txid());
7319
7320                         let index = node_txn[1].input[0].previous_output.vout;
7321                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7322                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7323                         assert!(new_feerate * 100 > feerate_preimage * 125);
7324                         assert_ne!(preimage, node_txn[1].txid());
7325                 } else {
7326                         let index = node_txn[1].input[0].previous_output.vout;
7327                         let fee = remote_txn[0].output[index as usize].value - node_txn[1].output[0].value;
7328                         let new_feerate = fee * 1000 / node_txn[1].get_weight() as u64;
7329                         assert!(new_feerate * 100 > feerate_timeout * 125);
7330                         assert_ne!(timeout, node_txn[1].txid());
7331
7332                         let index = node_txn[0].input[0].previous_output.vout;
7333                         let fee = remote_txn[0].output[index as usize].value - node_txn[0].output[0].value;
7334                         let new_feerate = fee * 1000 / node_txn[0].get_weight() as u64;
7335                         assert!(new_feerate * 100 > feerate_preimage * 125);
7336                         assert_ne!(preimage, node_txn[0].txid());
7337                 }
7338                 node_txn.clear();
7339         }
7340
7341         nodes[1].node.get_and_clear_pending_events();
7342         nodes[1].node.get_and_clear_pending_msg_events();
7343 }
7344
7345 #[test]
7346 fn test_set_outpoints_partial_claiming() {
7347         // - remote party claim tx, new bump tx
7348         // - disconnect remote claiming tx, new bump
7349         // - disconnect tx, see no tx anymore
7350         let chanmon_cfgs = create_chanmon_cfgs(2);
7351         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7352         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7353         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7354
7355         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7356         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7357         let payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3_000_000).0;
7358
7359         // Remote commitment txn with 4 outputs: to_local, to_remote, 2 outgoing HTLC
7360         let remote_txn = get_local_commitment_txn!(nodes[1], chan.2);
7361         assert_eq!(remote_txn.len(), 3);
7362         assert_eq!(remote_txn[0].output.len(), 4);
7363         assert_eq!(remote_txn[0].input.len(), 1);
7364         assert_eq!(remote_txn[0].input[0].previous_output.txid, chan.3.txid());
7365         check_spends!(remote_txn[1], remote_txn[0]);
7366         check_spends!(remote_txn[2], remote_txn[0]);
7367
7368         // Connect blocks on node A to advance height towards TEST_FINAL_CLTV
7369         let prev_header_100 = connect_blocks(&nodes[1].block_notifier, 100, 0, false, Default::default());
7370         // Provide node A with both preimage
7371         nodes[0].node.claim_funds(payment_preimage_1, 3_000_000);
7372         nodes[0].node.claim_funds(payment_preimage_2, 3_000_000);
7373         check_added_monitors!(nodes[0], 2);
7374         nodes[0].node.get_and_clear_pending_events();
7375         nodes[0].node.get_and_clear_pending_msg_events();
7376
7377         // Connect blocks on node A commitment transaction
7378         let header = BlockHeader { version: 0x20000000, prev_blockhash: prev_header_100, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7379         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 101);
7380         check_closed_broadcast!(nodes[0], false);
7381         check_added_monitors!(nodes[0], 1);
7382         // Verify node A broadcast tx claiming both HTLCs
7383         {
7384                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7385                 // ChannelMonitor: claim tx, ChannelManager: local commitment tx + HTLC-Success*2
7386                 assert_eq!(node_txn.len(), 4);
7387                 check_spends!(node_txn[0], remote_txn[0]);
7388                 check_spends!(node_txn[1], chan.3);
7389                 check_spends!(node_txn[2], node_txn[1]);
7390                 check_spends!(node_txn[3], node_txn[1]);
7391                 assert_eq!(node_txn[0].input.len(), 2);
7392                 node_txn.clear();
7393         }
7394
7395         // Connect blocks on node B
7396         connect_blocks(&nodes[1].block_notifier, 135, 0, false, Default::default());
7397         check_closed_broadcast!(nodes[1], false);
7398         check_added_monitors!(nodes[1], 1);
7399         // Verify node B broadcast 2 HTLC-timeout txn
7400         let partial_claim_tx = {
7401                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
7402                 assert_eq!(node_txn.len(), 3);
7403                 check_spends!(node_txn[1], node_txn[0]);
7404                 check_spends!(node_txn[2], node_txn[0]);
7405                 assert_eq!(node_txn[1].input.len(), 1);
7406                 assert_eq!(node_txn[2].input.len(), 1);
7407                 node_txn[1].clone()
7408         };
7409
7410         // Broadcast partial claim on node A, should regenerate a claiming tx with HTLC dropped
7411         let header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7412         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![partial_claim_tx.clone()] }, 102);
7413         {
7414                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7415                 assert_eq!(node_txn.len(), 1);
7416                 check_spends!(node_txn[0], remote_txn[0]);
7417                 assert_eq!(node_txn[0].input.len(), 1); //dropped HTLC
7418                 node_txn.clear();
7419         }
7420         nodes[0].node.get_and_clear_pending_msg_events();
7421
7422         // Disconnect last block on node A, should regenerate a claiming tx with HTLC dropped
7423         nodes[0].block_notifier.block_disconnected(&header, 102);
7424         {
7425                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7426                 assert_eq!(node_txn.len(), 1);
7427                 check_spends!(node_txn[0], remote_txn[0]);
7428                 assert_eq!(node_txn[0].input.len(), 2); //resurrected HTLC
7429                 node_txn.clear();
7430         }
7431
7432         //// Disconnect one more block and then reconnect multiple no transaction should be generated
7433         nodes[0].block_notifier.block_disconnected(&header, 101);
7434         connect_blocks(&nodes[1].block_notifier, 15, 101, false, prev_header_100);
7435         {
7436                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7437                 assert_eq!(node_txn.len(), 0);
7438                 node_txn.clear();
7439         }
7440 }
7441
7442 #[test]
7443 fn test_counterparty_raa_skip_no_crash() {
7444         // Previously, if our counterparty sent two RAAs in a row without us having provided a
7445         // commitment transaction, we would have happily carried on and provided them the next
7446         // commitment transaction based on one RAA forward. This would probably eventually have led to
7447         // channel closure, but it would not have resulted in funds loss. Still, our
7448         // EnforcingChannelKeys would have paniced as it doesn't like jumps into the future. Here, we
7449         // check simply that the channel is closed in response to such an RAA, but don't check whether
7450         // we decide to punish our counterparty for revoking their funds (as we don't currently
7451         // implement that).
7452         let chanmon_cfgs = create_chanmon_cfgs(2);
7453         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7454         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7455         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7456         let channel_id = create_announced_chan_between_nodes(&nodes, 0, 1, InitFeatures::supported(), InitFeatures::supported()).2;
7457
7458         let commitment_seed = nodes[0].node.channel_state.lock().unwrap().by_id.get_mut(&channel_id).unwrap().local_keys.commitment_seed().clone();
7459         const INITIAL_COMMITMENT_NUMBER: u64 = (1 << 48) - 1;
7460         let next_per_commitment_point = PublicKey::from_secret_key(&Secp256k1::new(),
7461                 &SecretKey::from_slice(&chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER - 2)).unwrap());
7462         let per_commitment_secret = chan_utils::build_commitment_secret(&commitment_seed, INITIAL_COMMITMENT_NUMBER);
7463
7464         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(),
7465                 &msgs::RevokeAndACK { channel_id, per_commitment_secret, next_per_commitment_point });
7466         assert_eq!(check_closed_broadcast!(nodes[1], true).unwrap().data, "Received an unexpected revoke_and_ack");
7467         check_added_monitors!(nodes[1], 1);
7468 }
7469
7470 #[test]
7471 fn test_bump_txn_sanitize_tracking_maps() {
7472         // Sanitizing pendning_claim_request and claimable_outpoints used to be buggy,
7473         // verify we clean then right after expiration of ANTI_REORG_DELAY.
7474
7475         let chanmon_cfgs = create_chanmon_cfgs(2);
7476         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7477         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7478         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7479
7480         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 59000000, InitFeatures::supported(), InitFeatures::supported());
7481         // Lock HTLC in both directions
7482         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9_000_000).0;
7483         route_payment(&nodes[1], &vec!(&nodes[0])[..], 9_000_000).0;
7484
7485         let revoked_local_txn = get_local_commitment_txn!(nodes[1], chan.2);
7486         assert_eq!(revoked_local_txn[0].input.len(), 1);
7487         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
7488
7489         // Revoke local commitment tx
7490         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 9_000_000);
7491
7492         // Broadcast set of revoked txn on A
7493         let header_128 = connect_blocks(&nodes[0].block_notifier, 128, 0,  false, Default::default());
7494         let header_129 = BlockHeader { version: 0x20000000, prev_blockhash: header_128, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7495         nodes[0].block_notifier.block_connected(&Block { header: header_129, txdata: vec![revoked_local_txn[0].clone()] }, 129);
7496         check_closed_broadcast!(nodes[0], false);
7497         check_added_monitors!(nodes[0], 1);
7498         let penalty_txn = {
7499                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
7500                 assert_eq!(node_txn.len(), 4); //ChannelMonitor: justice txn * 3, ChannelManager: local commitment tx
7501                 check_spends!(node_txn[0], revoked_local_txn[0]);
7502                 check_spends!(node_txn[1], revoked_local_txn[0]);
7503                 check_spends!(node_txn[2], revoked_local_txn[0]);
7504                 let penalty_txn = vec![node_txn[0].clone(), node_txn[1].clone(), node_txn[2].clone()];
7505                 node_txn.clear();
7506                 penalty_txn
7507         };
7508         let header_130 = BlockHeader { version: 0x20000000, prev_blockhash: header_129.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
7509         nodes[0].block_notifier.block_connected(&Block { header: header_130, txdata: penalty_txn }, 130);
7510         connect_blocks(&nodes[0].block_notifier, 5, 130,  false, header_130.bitcoin_hash());
7511         {
7512                 let monitors = nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap();
7513                 if let Some(monitor) = monitors.get(&OutPoint::new(chan.3.txid(), 0)) {
7514                         assert!(monitor.onchain_tx_handler.pending_claim_requests.is_empty());
7515                         assert!(monitor.onchain_tx_handler.claimable_outpoints.is_empty());
7516                 }
7517         }
7518 }
7519
7520 #[test]
7521 fn test_override_channel_config() {
7522         let chanmon_cfgs = create_chanmon_cfgs(2);
7523         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7524         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
7525         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7526
7527         // Node0 initiates a channel to node1 using the override config.
7528         let mut override_config = UserConfig::default();
7529         override_config.own_channel_config.our_to_self_delay = 200;
7530
7531         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(override_config)).unwrap();
7532
7533         // Assert the channel created by node0 is using the override config.
7534         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7535         assert_eq!(res.channel_flags, 0);
7536         assert_eq!(res.to_self_delay, 200);
7537 }
7538
7539 #[test]
7540 fn test_override_0msat_htlc_minimum() {
7541         let mut zero_config = UserConfig::default();
7542         zero_config.own_channel_config.our_htlc_minimum_msat = 0;
7543         let chanmon_cfgs = create_chanmon_cfgs(2);
7544         let node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
7545         let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, Some(zero_config.clone())]);
7546         let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
7547
7548         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 16_000_000, 12_000_000, 42, Some(zero_config)).unwrap();
7549         let res = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
7550         assert_eq!(res.htlc_minimum_msat, 1);
7551
7552         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), InitFeatures::supported(), &res);
7553         let res = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
7554         assert_eq!(res.htlc_minimum_msat, 1);
7555 }