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