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