_ 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::chaininterface::{ChainListener, ChainWatchInterfaceUtil};
   7 use chain::keysinterface::{KeysInterface, SpendableOutputDescriptor, KeysManager};
   8 use chain::keysinterface;
   9 use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
  10 use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,HTLCForwardInfo,RAACommitmentOrder, PaymentPreimage, PaymentHash, BREAKDOWN_TIMEOUT};
  11 use ln::channelmonitor::{ChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ManyChannelMonitor, ANTI_REORG_DELAY};
  12 use ln::channel::{ACCEPTED_HTLC_SCRIPT_WEIGHT, OFFERED_HTLC_SCRIPT_WEIGHT, Channel, ChannelError};
  13 use ln::onion_utils;
  14 use ln::router::{Route, RouteHop};
  15 use ln::msgs;
  16 use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler,HTLCFailChannelUpdate, LocalFeatures, ErrorAction};
  17 use util::test_utils;
  18 use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
  19 use util::errors::APIError;
  20 use util::ser::{Writeable, ReadableArgs};
  21 use util::config::UserConfig;
  22 use util::logger::Logger;
  23
  24 use bitcoin::util::hash::BitcoinHash;
  25 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
  26 use bitcoin::util::bip143;
  27 use bitcoin::util::address::Address;
  28 use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
  29 use bitcoin::blockdata::block::{Block, BlockHeader};
  30 use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType, OutPoint as BitcoinOutPoint};
  31 use bitcoin::blockdata::script::{Builder, Script};
  32 use bitcoin::blockdata::opcodes;
  33 use bitcoin::blockdata::constants::genesis_block;
  34 use bitcoin::network::constants::Network;
  35
  36 use bitcoin_hashes::sha256::Hash as Sha256;
  37 use bitcoin_hashes::Hash;
  38
  39 use secp256k1::{Secp256k1, Message};
  40 use secp256k1::key::{PublicKey,SecretKey};
  41
  42 use std::collections::{BTreeSet, HashMap, HashSet};
  43 use std::default::Default;
  44 use std::sync::{Arc, Mutex};
  45 use std::sync::atomic::Ordering;
  46 use std::mem;
  47
  48 use rand::{thread_rng, Rng};
  49
  50 use ln::functional_test_utils::*;
  51
  52 #[test]
  53 fn test_insane_channel_opens() {
  54         // Stand up a network of 2 nodes
  55         let nodes = create_network(2, &[None, None]);
  56
  57         // Instantiate channel parameters where we push the maximum msats given our
  58         // funding satoshis
  59         let channel_value_sat = 31337; // same as funding satoshis
  60         let channel_reserve_satoshis = Channel::get_our_channel_reserve_satoshis(channel_value_sat);
  61         let push_msat = (channel_value_sat - channel_reserve_satoshis) * 1000;
  62
  63         // Have node0 initiate a channel to node1 with aforementioned parameters
  64         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_sat, push_msat, 42).unwrap();
  65
  66         // Extract the channel open message from node0 to node1
  67         let open_channel_message = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
  68
  69         // Test helper that asserts we get the correct error string given a mutator
  70         // that supposedly makes the channel open message insane
  71         let insane_open_helper = |expected_error_str, message_mutator: fn(msgs::OpenChannel) -> msgs::OpenChannel| {
  72                 match nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), LocalFeatures::new(), &message_mutator(open_channel_message.clone())) {
  73                         Err(msgs::LightningError{ err: error_str, action: msgs::ErrorAction::SendErrorMessage {..}}) => {
  74                                 assert_eq!(error_str, expected_error_str, "unexpected LightningError string (expected `{}`, actual `{}`)", expected_error_str, error_str)
  75                         },
  76                         Err(msgs::LightningError{..}) => {panic!("unexpected LightningError action")},
  77                         _ => panic!("insane OpenChannel message was somehow Ok"),
  78                 }
  79         };
  80
  81         use ln::channel::MAX_FUNDING_SATOSHIS;
  82         use ln::channelmanager::MAX_LOCAL_BREAKDOWN_TIMEOUT;
  83
  84         // Test all mutations that would make the channel open message insane
  85         insane_open_helper("funding value > 2^24", |mut msg| { msg.funding_satoshis = MAX_FUNDING_SATOSHIS; msg });
  86
  87         insane_open_helper("Bogus channel_reserve_satoshis", |mut msg| { msg.channel_reserve_satoshis = msg.funding_satoshis + 1; msg });
  88
  89         insane_open_helper("push_msat larger than funding value", |mut msg| { msg.push_msat = (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 + 1; msg });
  90
  91         insane_open_helper("Peer never wants payout outputs?", |mut msg| { msg.dust_limit_satoshis = msg.funding_satoshis + 1 ; msg });
  92
  93         insane_open_helper("Bogus; channel reserve is less than dust limit", |mut msg| { msg.dust_limit_satoshis = msg.channel_reserve_satoshis + 1; msg });
  94
  95         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 });
  96
  97         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 });
  98
  99         insane_open_helper("0 max_accpted_htlcs makes for a useless channel", |mut msg| { msg.max_accepted_htlcs = 0; msg });
 100
 101         insane_open_helper("max_accpted_htlcs > 483", |mut msg| { msg.max_accepted_htlcs = 484; msg });
 102 }
 103
 104 #[test]
 105 fn test_async_inbound_update_fee() {
 106         let mut nodes = create_network(2, &[None, None]);
 107         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
 108         let channel_id = chan.2;
 109
 110         // balancing
 111         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 112
 113         // A                                        B
 114         // update_fee                            ->
 115         // send (1) commitment_signed            -.
 116         //                                       <- update_add_htlc/commitment_signed
 117         // send (2) RAA (awaiting remote revoke) -.
 118         // (1) commitment_signed is delivered    ->
 119         //                                       .- send (3) RAA (awaiting remote revoke)
 120         // (2) RAA is delivered                  ->
 121         //                                       .- send (4) commitment_signed
 122         //                                       <- (3) RAA is delivered
 123         // send (5) commitment_signed            -.
 124         //                                       <- (4) commitment_signed is delivered
 125         // send (6) RAA                          -.
 126         // (5) commitment_signed is delivered    ->
 127         //                                       <- RAA
 128         // (6) RAA is delivered                  ->
 129
 130         // First nodes[0] generates an update_fee
 131         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 132         check_added_monitors!(nodes[0], 1);
 133
 134         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 135         assert_eq!(events_0.len(), 1);
 136         let (update_msg, commitment_signed) = match events_0[0] { // (1)
 137                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 138                         (update_fee.as_ref(), commitment_signed)
 139                 },
 140                 _ => panic!("Unexpected event"),
 141         };
 142
 143         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 144
 145         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 146         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 147         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();
 148         check_added_monitors!(nodes[1], 1);
 149
 150         let payment_event = {
 151                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 152                 assert_eq!(events_1.len(), 1);
 153                 SendEvent::from_event(events_1.remove(0))
 154         };
 155         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 156         assert_eq!(payment_event.msgs.len(), 1);
 157
 158         // ...now when the messages get delivered everyone should be happy
 159         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
 160         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
 161         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 162         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 163         check_added_monitors!(nodes[0], 1);
 164
 165         // deliver(1), generate (3):
 166         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
 167         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 168         // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
 169         check_added_monitors!(nodes[1], 1);
 170
 171         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap(); // deliver (2)
 172         let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 173         assert!(bs_update.update_add_htlcs.is_empty()); // (4)
 174         assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
 175         assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
 176         assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
 177         assert!(bs_update.update_fee.is_none()); // (4)
 178         check_added_monitors!(nodes[1], 1);
 179
 180         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap(); // deliver (3)
 181         let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 182         assert!(as_update.update_add_htlcs.is_empty()); // (5)
 183         assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
 184         assert!(as_update.update_fail_htlcs.is_empty()); // (5)
 185         assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
 186         assert!(as_update.update_fee.is_none()); // (5)
 187         check_added_monitors!(nodes[0], 1);
 188
 189         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed).unwrap(); // deliver (4)
 190         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 191         // only (6) so get_event_msg's assert(len == 1) passes
 192         check_added_monitors!(nodes[0], 1);
 193
 194         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed).unwrap(); // deliver (5)
 195         let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 196         check_added_monitors!(nodes[1], 1);
 197
 198         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
 199         check_added_monitors!(nodes[0], 1);
 200
 201         let events_2 = nodes[0].node.get_and_clear_pending_events();
 202         assert_eq!(events_2.len(), 1);
 203         match events_2[0] {
 204                 Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
 205                 _ => panic!("Unexpected event"),
 206         }
 207
 208         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap(); // deliver (6)
 209         check_added_monitors!(nodes[1], 1);
 210 }
 211
 212 #[test]
 213 fn test_update_fee_unordered_raa() {
 214         // Just the intro to the previous test followed by an out-of-order RAA (which caused a
 215         // crash in an earlier version of the update_fee patch)
 216         let mut nodes = create_network(2, &[None, None]);
 217         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
 218         let channel_id = chan.2;
 219
 220         // balancing
 221         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 222
 223         // First nodes[0] generates an update_fee
 224         nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
 225         check_added_monitors!(nodes[0], 1);
 226
 227         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 228         assert_eq!(events_0.len(), 1);
 229         let update_msg = match events_0[0] { // (1)
 230                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
 231                         update_fee.as_ref()
 232                 },
 233                 _ => panic!("Unexpected event"),
 234         };
 235
 236         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 237
 238         // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
 239         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 240         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();
 241         check_added_monitors!(nodes[1], 1);
 242
 243         let payment_event = {
 244                 let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
 245                 assert_eq!(events_1.len(), 1);
 246                 SendEvent::from_event(events_1.remove(0))
 247         };
 248         assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
 249         assert_eq!(payment_event.msgs.len(), 1);
 250
 251         // ...now when the messages get delivered everyone should be happy
 252         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
 253         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
 254         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 255         // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
 256         check_added_monitors!(nodes[0], 1);
 257
 258         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
 259         check_added_monitors!(nodes[1], 1);
 260
 261         // We can't continue, sadly, because our (1) now has a bogus signature
 262 }
 263
 264 #[test]
 265 fn test_multi_flight_update_fee() {
 266         let nodes = create_network(2, &[None, None]);
 267         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
 268         let channel_id = chan.2;
 269
 270         // A                                        B
 271         // update_fee/commitment_signed          ->
 272         //                                       .- send (1) RAA and (2) commitment_signed
 273         // update_fee (never committed)          ->
 274         // (3) update_fee                        ->
 275         // We have to manually generate the above update_fee, it is allowed by the protocol but we
 276         // don't track which updates correspond to which revoke_and_ack responses so we're in
 277         // AwaitingRAA mode and will not generate the update_fee yet.
 278         //                                       <- (1) RAA delivered
 279         // (3) is generated and send (4) CS      -.
 280         // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
 281         // know the per_commitment_point to use for it.
 282         //                                       <- (2) commitment_signed delivered
 283         // revoke_and_ack                        ->
 284         //                                          B should send no response here
 285         // (4) commitment_signed delivered       ->
 286         //                                       <- RAA/commitment_signed delivered
 287         // revoke_and_ack                        ->
 288
 289         // First nodes[0] generates an update_fee
 290         let initial_feerate = get_feerate!(nodes[0], channel_id);
 291         nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
 292         check_added_monitors!(nodes[0], 1);
 293
 294         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 295         assert_eq!(events_0.len(), 1);
 296         let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
 297                 MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
 298                         (update_fee.as_ref().unwrap(), commitment_signed)
 299                 },
 300                 _ => panic!("Unexpected event"),
 301         };
 302
 303         // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
 304         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
 305         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
 306         let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 307         check_added_monitors!(nodes[1], 1);
 308
 309         // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
 310         // transaction:
 311         nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
 312         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 313         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 314
 315         // Create the (3) update_fee message that nodes[0] will generate before it does...
 316         let mut update_msg_2 = msgs::UpdateFee {
 317                 channel_id: update_msg_1.channel_id.clone(),
 318                 feerate_per_kw: (initial_feerate + 30) as u32,
 319         };
 320
 321         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
 322
 323         update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
 324         // Deliver (3)
 325         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
 326
 327         // Deliver (1), generating (3) and (4)
 328         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
 329         let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 330         check_added_monitors!(nodes[0], 1);
 331         assert!(as_second_update.update_add_htlcs.is_empty());
 332         assert!(as_second_update.update_fulfill_htlcs.is_empty());
 333         assert!(as_second_update.update_fail_htlcs.is_empty());
 334         assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
 335         // Check that the update_fee newly generated matches what we delivered:
 336         assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
 337         assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
 338
 339         // Deliver (2) commitment_signed
 340         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
 341         let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 342         check_added_monitors!(nodes[0], 1);
 343         // No commitment_signed so get_event_msg's assert(len == 1) passes
 344
 345         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap();
 346         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 347         check_added_monitors!(nodes[1], 1);
 348
 349         // Delever (4)
 350         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed).unwrap();
 351         let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 352         check_added_monitors!(nodes[1], 1);
 353
 354         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
 355         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 356         check_added_monitors!(nodes[0], 1);
 357
 358         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment).unwrap();
 359         let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 360         // No commitment_signed so get_event_msg's assert(len == 1) passes
 361         check_added_monitors!(nodes[0], 1);
 362
 363         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap();
 364         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 365         check_added_monitors!(nodes[1], 1);
 366 }
 367
 368 #[test]
 369 fn test_update_fee_vanilla() {
 370         let nodes = create_network(2, &[None, None]);
 371         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
 372         let channel_id = chan.2;
 373
 374         let feerate = get_feerate!(nodes[0], channel_id);
 375         nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
 376         check_added_monitors!(nodes[0], 1);
 377
 378         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 379         assert_eq!(events_0.len(), 1);
 380         let (update_msg, commitment_signed) = match events_0[0] {
 381                         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 } } => {
 382                         (update_fee.as_ref(), commitment_signed)
 383                 },
 384                 _ => panic!("Unexpected event"),
 385         };
 386         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 387
 388         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
 389         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 390         check_added_monitors!(nodes[1], 1);
 391
 392         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
 393         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 394         check_added_monitors!(nodes[0], 1);
 395
 396         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
 397         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 398         // No commitment_signed so get_event_msg's assert(len == 1) passes
 399         check_added_monitors!(nodes[0], 1);
 400
 401         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
 402         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 403         check_added_monitors!(nodes[1], 1);
 404 }
 405
 406 #[test]
 407 fn test_update_fee_that_funder_cannot_afford() {
 408         let nodes = create_network(2, &[None, None]);
 409         let channel_value = 1888;
 410         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000, LocalFeatures::new(), LocalFeatures::new());
 411         let channel_id = chan.2;
 412
 413         let feerate = 260;
 414         nodes[0].node.update_fee(channel_id, feerate).unwrap();
 415         check_added_monitors!(nodes[0], 1);
 416         let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 417
 418         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap()).unwrap();
 419
 420         commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
 421
 422         //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
 423         //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
 424         {
 425                 let chan_lock = nodes[1].node.channel_state.lock().unwrap();
 426                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
 427
 428                 //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
 429                 let num_htlcs = chan.last_local_commitment_txn[0].output.len() - 2;
 430                 let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
 431                 let mut actual_fee = chan.last_local_commitment_txn[0].output.iter().fold(0, |acc, output| acc + output.value);
 432                 actual_fee = channel_value - actual_fee;
 433                 assert_eq!(total_fee, actual_fee);
 434         } //drop the mutex
 435
 436         //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
 437         //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
 438         nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
 439         check_added_monitors!(nodes[0], 1);
 440
 441         let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 442
 443         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap()).unwrap();
 444
 445         //While producing the commitment_signed response after handling a received update_fee request the
 446         //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
 447         //Should produce and error.
 448         let err = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed).unwrap_err();
 449
 450         assert!(match err.err {
 451                 "Funding remote cannot afford proposed new fee" => true,
 452                 _ => false,
 453         });
 454
 455         //clear the message we could not handle
 456         nodes[1].node.get_and_clear_pending_msg_events();
 457 }
 458
 459 #[test]
 460 fn test_update_fee_with_fundee_update_add_htlc() {
 461         let mut nodes = create_network(2, &[None, None]);
 462         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
 463         let channel_id = chan.2;
 464
 465         // balancing
 466         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
 467
 468         let feerate = get_feerate!(nodes[0], channel_id);
 469         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 470         check_added_monitors!(nodes[0], 1);
 471
 472         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 473         assert_eq!(events_0.len(), 1);
 474         let (update_msg, commitment_signed) = match events_0[0] {
 475                         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 } } => {
 476                         (update_fee.as_ref(), commitment_signed)
 477                 },
 478                 _ => panic!("Unexpected event"),
 479         };
 480         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 481         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
 482         let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 483         check_added_monitors!(nodes[1], 1);
 484
 485         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
 486
 487         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
 488
 489         // nothing happens since node[1] is in AwaitingRemoteRevoke
 490         nodes[1].node.send_payment(route, our_payment_hash).unwrap();
 491         {
 492                 let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
 493                 assert_eq!(added_monitors.len(), 0);
 494                 added_monitors.clear();
 495         }
 496         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
 497         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 498         // node[1] has nothing to do
 499
 500         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
 501         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 502         check_added_monitors!(nodes[0], 1);
 503
 504         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
 505         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 506         // No commitment_signed so get_event_msg's assert(len == 1) passes
 507         check_added_monitors!(nodes[0], 1);
 508         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
 509         check_added_monitors!(nodes[1], 1);
 510         // AwaitingRemoteRevoke ends here
 511
 512         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 513         assert_eq!(commitment_update.update_add_htlcs.len(), 1);
 514         assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
 515         assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
 516         assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
 517         assert_eq!(commitment_update.update_fee.is_none(), true);
 518
 519         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
 520         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
 521         check_added_monitors!(nodes[0], 1);
 522         let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 523
 524         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
 525         check_added_monitors!(nodes[1], 1);
 526         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 527
 528         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
 529         check_added_monitors!(nodes[1], 1);
 530         let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 531         // No commitment_signed so get_event_msg's assert(len == 1) passes
 532
 533         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
 534         check_added_monitors!(nodes[0], 1);
 535         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 536
 537         expect_pending_htlcs_forwardable!(nodes[0]);
 538
 539         let events = nodes[0].node.get_and_clear_pending_events();
 540         assert_eq!(events.len(), 1);
 541         match events[0] {
 542                 Event::PaymentReceived { .. } => { },
 543                 _ => panic!("Unexpected event"),
 544         };
 545
 546         claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage, 800_000);
 547
 548         send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000, 800_000);
 549         send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000, 800_000);
 550         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 551 }
 552
 553 #[test]
 554 fn test_update_fee() {
 555         let nodes = create_network(2, &[None, None]);
 556         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
 557         let channel_id = chan.2;
 558
 559         // A                                        B
 560         // (1) update_fee/commitment_signed      ->
 561         //                                       <- (2) revoke_and_ack
 562         //                                       .- send (3) commitment_signed
 563         // (4) update_fee/commitment_signed      ->
 564         //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
 565         //                                       <- (3) commitment_signed delivered
 566         // send (6) revoke_and_ack               -.
 567         //                                       <- (5) deliver revoke_and_ack
 568         // (6) deliver revoke_and_ack            ->
 569         //                                       .- send (7) commitment_signed in response to (4)
 570         //                                       <- (7) deliver commitment_signed
 571         // revoke_and_ack                        ->
 572
 573         // Create and deliver (1)...
 574         let feerate = get_feerate!(nodes[0], channel_id);
 575         nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
 576         check_added_monitors!(nodes[0], 1);
 577
 578         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 579         assert_eq!(events_0.len(), 1);
 580         let (update_msg, commitment_signed) = match events_0[0] {
 581                         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 } } => {
 582                         (update_fee.as_ref(), commitment_signed)
 583                 },
 584                 _ => panic!("Unexpected event"),
 585         };
 586         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 587
 588         // Generate (2) and (3):
 589         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
 590         let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 591         check_added_monitors!(nodes[1], 1);
 592
 593         // Deliver (2):
 594         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
 595         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 596         check_added_monitors!(nodes[0], 1);
 597
 598         // Create and deliver (4)...
 599         nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
 600         check_added_monitors!(nodes[0], 1);
 601         let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
 602         assert_eq!(events_0.len(), 1);
 603         let (update_msg, commitment_signed) = match events_0[0] {
 604                         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 } } => {
 605                         (update_fee.as_ref(), commitment_signed)
 606                 },
 607                 _ => panic!("Unexpected event"),
 608         };
 609
 610         nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
 611         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
 612         check_added_monitors!(nodes[1], 1);
 613         // ... creating (5)
 614         let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
 615         // No commitment_signed so get_event_msg's assert(len == 1) passes
 616
 617         // Handle (3), creating (6):
 618         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
 619         check_added_monitors!(nodes[0], 1);
 620         let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 621         // No commitment_signed so get_event_msg's assert(len == 1) passes
 622
 623         // Deliver (5):
 624         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
 625         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 626         check_added_monitors!(nodes[0], 1);
 627
 628         // Deliver (6), creating (7):
 629         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
 630         let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 631         assert!(commitment_update.update_add_htlcs.is_empty());
 632         assert!(commitment_update.update_fulfill_htlcs.is_empty());
 633         assert!(commitment_update.update_fail_htlcs.is_empty());
 634         assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
 635         assert!(commitment_update.update_fee.is_none());
 636         check_added_monitors!(nodes[1], 1);
 637
 638         // Deliver (7)
 639         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
 640         check_added_monitors!(nodes[0], 1);
 641         let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
 642         // No commitment_signed so get_event_msg's assert(len == 1) passes
 643
 644         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
 645         check_added_monitors!(nodes[1], 1);
 646         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 647
 648         assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
 649         assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
 650         close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
 651 }
 652
 653 #[test]
 654 fn pre_funding_lock_shutdown_test() {
 655         // Test sending a shutdown prior to funding_locked after funding generation
 656         let nodes = create_network(2, &[None, None]);
 657         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0, LocalFeatures::new(), LocalFeatures::new());
 658         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
 659         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 660         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![tx.clone()]}, 1);
 661
 662         nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
 663         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 664         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
 665         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 666         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
 667
 668         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 669         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
 670         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 671         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
 672         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 673         assert!(node_0_none.is_none());
 674
 675         assert!(nodes[0].node.list_channels().is_empty());
 676         assert!(nodes[1].node.list_channels().is_empty());
 677 }
 678
 679 #[test]
 680 fn updates_shutdown_wait() {
 681         // Test sending a shutdown with outstanding updates pending
 682         let mut nodes = create_network(3, &[None, None, None]);
 683         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
 684         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
 685         let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 686         let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 687
 688         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 689
 690         nodes[0].node.close_channel(&chan_1.2).unwrap();
 691         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 692         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
 693         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 694         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
 695
 696         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 697         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 698
 699         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
 700         if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
 701         else { panic!("New sends should fail!") };
 702         if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
 703         else { panic!("New sends should fail!") };
 704
 705         assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
 706         check_added_monitors!(nodes[2], 1);
 707         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 708         assert!(updates.update_add_htlcs.is_empty());
 709         assert!(updates.update_fail_htlcs.is_empty());
 710         assert!(updates.update_fail_malformed_htlcs.is_empty());
 711         assert!(updates.update_fee.is_none());
 712         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 713         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
 714         check_added_monitors!(nodes[1], 1);
 715         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 716         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 717
 718         assert!(updates_2.update_add_htlcs.is_empty());
 719         assert!(updates_2.update_fail_htlcs.is_empty());
 720         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 721         assert!(updates_2.update_fee.is_none());
 722         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 723         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
 724         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 725
 726         let events = nodes[0].node.get_and_clear_pending_events();
 727         assert_eq!(events.len(), 1);
 728         match events[0] {
 729                 Event::PaymentSent { ref payment_preimage } => {
 730                         assert_eq!(our_payment_preimage, *payment_preimage);
 731                 },
 732                 _ => panic!("Unexpected event"),
 733         }
 734
 735         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 736         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
 737         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 738         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
 739         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 740         assert!(node_0_none.is_none());
 741
 742         assert!(nodes[0].node.list_channels().is_empty());
 743
 744         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 745         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 746         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 747         assert!(nodes[1].node.list_channels().is_empty());
 748         assert!(nodes[2].node.list_channels().is_empty());
 749 }
 750
 751 #[test]
 752 fn htlc_fail_async_shutdown() {
 753         // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
 754         let mut nodes = create_network(3, &[None, None, None]);
 755         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
 756         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
 757
 758         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
 759         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
 760         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
 761         check_added_monitors!(nodes[0], 1);
 762         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
 763         assert_eq!(updates.update_add_htlcs.len(), 1);
 764         assert!(updates.update_fulfill_htlcs.is_empty());
 765         assert!(updates.update_fail_htlcs.is_empty());
 766         assert!(updates.update_fail_malformed_htlcs.is_empty());
 767         assert!(updates.update_fee.is_none());
 768
 769         nodes[1].node.close_channel(&chan_1.2).unwrap();
 770         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 771         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
 772         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 773
 774         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
 775         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
 776         check_added_monitors!(nodes[1], 1);
 777         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
 778         commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
 779
 780         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 781         assert!(updates_2.update_add_htlcs.is_empty());
 782         assert!(updates_2.update_fulfill_htlcs.is_empty());
 783         assert_eq!(updates_2.update_fail_htlcs.len(), 1);
 784         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 785         assert!(updates_2.update_fee.is_none());
 786
 787         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]).unwrap();
 788         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 789
 790         let events = nodes[0].node.get_and_clear_pending_events();
 791         assert_eq!(events.len(), 1);
 792         match events[0] {
 793                 Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } => {
 794                         assert_eq!(our_payment_hash, *payment_hash);
 795                         assert!(!rejected_by_dest);
 796                 },
 797                 _ => panic!("Unexpected event"),
 798         }
 799
 800         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
 801         assert_eq!(msg_events.len(), 2);
 802         let node_0_closing_signed = match msg_events[0] {
 803                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
 804                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
 805                         (*msg).clone()
 806                 },
 807                 _ => panic!("Unexpected event"),
 808         };
 809         match msg_events[1] {
 810                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
 811                         assert_eq!(msg.contents.short_channel_id, chan_1.0.contents.short_channel_id);
 812                 },
 813                 _ => panic!("Unexpected event"),
 814         }
 815
 816         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 817         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
 818         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 819         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
 820         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 821         assert!(node_0_none.is_none());
 822
 823         assert!(nodes[0].node.list_channels().is_empty());
 824
 825         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 826         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 827         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 828         assert!(nodes[1].node.list_channels().is_empty());
 829         assert!(nodes[2].node.list_channels().is_empty());
 830 }
 831
 832 fn do_test_shutdown_rebroadcast(recv_count: u8) {
 833         // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
 834         // messages delivered prior to disconnect
 835         let nodes = create_network(3, &[None, None, None]);
 836         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
 837         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
 838
 839         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
 840
 841         nodes[1].node.close_channel(&chan_1.2).unwrap();
 842         let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 843         if recv_count > 0 {
 844                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
 845                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 846                 if recv_count > 1 {
 847                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
 848                 }
 849         }
 850
 851         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 852         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 853
 854         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
 855         let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
 856         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
 857         let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
 858
 859         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish).unwrap();
 860         let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 861         assert!(node_1_shutdown == node_1_2nd_shutdown);
 862
 863         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish).unwrap();
 864         let node_0_2nd_shutdown = if recv_count > 0 {
 865                 let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 866                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
 867                 node_0_2nd_shutdown
 868         } else {
 869                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 870                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
 871                 get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
 872         };
 873         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown).unwrap();
 874
 875         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
 876         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 877
 878         assert!(nodes[2].node.claim_funds(our_payment_preimage, 100_000));
 879         check_added_monitors!(nodes[2], 1);
 880         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
 881         assert!(updates.update_add_htlcs.is_empty());
 882         assert!(updates.update_fail_htlcs.is_empty());
 883         assert!(updates.update_fail_malformed_htlcs.is_empty());
 884         assert!(updates.update_fee.is_none());
 885         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
 886         nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
 887         check_added_monitors!(nodes[1], 1);
 888         let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
 889         commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
 890
 891         assert!(updates_2.update_add_htlcs.is_empty());
 892         assert!(updates_2.update_fail_htlcs.is_empty());
 893         assert!(updates_2.update_fail_malformed_htlcs.is_empty());
 894         assert!(updates_2.update_fee.is_none());
 895         assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
 896         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
 897         commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
 898
 899         let events = nodes[0].node.get_and_clear_pending_events();
 900         assert_eq!(events.len(), 1);
 901         match events[0] {
 902                 Event::PaymentSent { ref payment_preimage } => {
 903                         assert_eq!(our_payment_preimage, *payment_preimage);
 904                 },
 905                 _ => panic!("Unexpected event"),
 906         }
 907
 908         let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 909         if recv_count > 0 {
 910                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
 911                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 912                 assert!(node_1_closing_signed.is_some());
 913         }
 914
 915         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
 916         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
 917
 918         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
 919         let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
 920         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
 921         if recv_count == 0 {
 922                 // If all closing_signeds weren't delivered we can just resume where we left off...
 923                 let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
 924
 925                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish).unwrap();
 926                 let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
 927                 assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
 928
 929                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish).unwrap();
 930                 let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
 931                 assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
 932
 933                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown).unwrap();
 934                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 935
 936                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown).unwrap();
 937                 let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
 938                 assert!(node_0_closing_signed == node_0_2nd_closing_signed);
 939
 940                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed).unwrap();
 941                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
 942                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
 943                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
 944                 assert!(node_0_none.is_none());
 945         } else {
 946                 // If one node, however, received + responded with an identical closing_signed we end
 947                 // up erroring and node[0] will try to broadcast its own latest commitment transaction.
 948                 // There isn't really anything better we can do simply, but in the future we might
 949                 // explore storing a set of recently-closed channels that got disconnected during
 950                 // closing_signed and avoiding broadcasting local commitment txn for some timeout to
 951                 // give our counterparty enough time to (potentially) broadcast a cooperative closing
 952                 // transaction.
 953                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
 954
 955                 if let Err(msgs::LightningError{action: msgs::ErrorAction::SendErrorMessage{msg}, ..}) =
 956                                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish) {
 957                         nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
 958                         let msgs::ErrorMessage {ref channel_id, ..} = msg;
 959                         assert_eq!(*channel_id, chan_1.2);
 960                 } else { panic!("Needed SendErrorMessage close"); }
 961
 962                 // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
 963                 // checks it, but in this case nodes[0] didn't ever get a chance to receive a
 964                 // closing_signed so we do it ourselves
 965                 check_closed_broadcast!(nodes[0]);
 966         }
 967
 968         assert!(nodes[0].node.list_channels().is_empty());
 969
 970         assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
 971         nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
 972         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
 973         assert!(nodes[1].node.list_channels().is_empty());
 974         assert!(nodes[2].node.list_channels().is_empty());
 975 }
 976
 977 #[test]
 978 fn test_shutdown_rebroadcast() {
 979         do_test_shutdown_rebroadcast(0);
 980         do_test_shutdown_rebroadcast(1);
 981         do_test_shutdown_rebroadcast(2);
 982 }
 983
 984 #[test]
 985 fn fake_network_test() {
 986         // Simple test which builds a network of ChannelManagers, connects them to each other, and
 987         // tests that payments get routed and transactions broadcast in semi-reasonable ways.
 988         let nodes = create_network(4, &[None, None, None, None]);
 989
 990         // Create some initial channels
 991         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
 992         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
 993         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, LocalFeatures::new(), LocalFeatures::new());
 994
 995         // Rebalance the network a bit by relaying one payment through all the channels...
 996         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
 997         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
 998         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
 999         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000, 8_000_000);
1000
1001         // Send some more payments
1002         send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000, 1_000_000);
1003         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000, 1_000_000);
1004         send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000, 1_000_000);
1005
1006         // Test failure packets
1007         let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
1008         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
1009
1010         // Add a new channel that skips 3
1011         let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3, LocalFeatures::new(), LocalFeatures::new());
1012
1013         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000, 1_000_000);
1014         send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000, 1_000_000);
1015         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1016         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1017         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1018         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1019         send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000, 8_000_000);
1020
1021         // Do some rebalance loop payments, simultaneously
1022         let mut hops = Vec::with_capacity(3);
1023         hops.push(RouteHop {
1024                 pubkey: nodes[2].node.get_our_node_id(),
1025                 short_channel_id: chan_2.0.contents.short_channel_id,
1026                 fee_msat: 0,
1027                 cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
1028         });
1029         hops.push(RouteHop {
1030                 pubkey: nodes[3].node.get_our_node_id(),
1031                 short_channel_id: chan_3.0.contents.short_channel_id,
1032                 fee_msat: 0,
1033                 cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
1034         });
1035         hops.push(RouteHop {
1036                 pubkey: nodes[1].node.get_our_node_id(),
1037                 short_channel_id: chan_4.0.contents.short_channel_id,
1038                 fee_msat: 1000000,
1039                 cltv_expiry_delta: TEST_FINAL_CLTV,
1040         });
1041         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;
1042         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;
1043         let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
1044
1045         let mut hops = Vec::with_capacity(3);
1046         hops.push(RouteHop {
1047                 pubkey: nodes[3].node.get_our_node_id(),
1048                 short_channel_id: chan_4.0.contents.short_channel_id,
1049                 fee_msat: 0,
1050                 cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
1051         });
1052         hops.push(RouteHop {
1053                 pubkey: nodes[2].node.get_our_node_id(),
1054                 short_channel_id: chan_3.0.contents.short_channel_id,
1055                 fee_msat: 0,
1056                 cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
1057         });
1058         hops.push(RouteHop {
1059                 pubkey: nodes[1].node.get_our_node_id(),
1060                 short_channel_id: chan_2.0.contents.short_channel_id,
1061                 fee_msat: 1000000,
1062                 cltv_expiry_delta: TEST_FINAL_CLTV,
1063         });
1064         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;
1065         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;
1066         let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
1067
1068         // Claim the rebalances...
1069         fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
1070         claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1, 1_000_000);
1071
1072         // Add a duplicate new channel from 2 to 4
1073         let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3, LocalFeatures::new(), LocalFeatures::new());
1074
1075         // Send some payments across both channels
1076         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1077         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1078         let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
1079
1080         route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
1081
1082         //TODO: Test that routes work again here as we've been notified that the channel is full
1083
1084         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3, 3_000_000);
1085         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4, 3_000_000);
1086         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5, 3_000_000);
1087
1088         // Close down the channels...
1089         close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
1090         close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
1091         close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
1092         close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
1093         close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
1094 }
1095
1096 #[test]
1097 fn holding_cell_htlc_counting() {
1098         // Tests that HTLCs in the holding cell count towards the pending HTLC limits on outbound HTLCs
1099         // to ensure we don't end up with HTLCs sitting around in our holding cell for several
1100         // commitment dance rounds.
1101         let mut nodes = create_network(3, &[None, None, None]);
1102         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
1103         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
1104
1105         let mut payments = Vec::new();
1106         for _ in 0..::ln::channel::OUR_MAX_HTLCS {
1107                 let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1108                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1109                 nodes[1].node.send_payment(route, payment_hash).unwrap();
1110                 payments.push((payment_preimage, payment_hash));
1111         }
1112         check_added_monitors!(nodes[1], 1);
1113
1114         let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1115         assert_eq!(events.len(), 1);
1116         let initial_payment_event = SendEvent::from_event(events.pop().unwrap());
1117         assert_eq!(initial_payment_event.node_id, nodes[2].node.get_our_node_id());
1118
1119         // There is now one HTLC in an outbound commitment transaction and (OUR_MAX_HTLCS - 1) HTLCs in
1120         // the holding cell waiting on B's RAA to send. At this point we should not be able to add
1121         // another HTLC.
1122         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1123         let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
1124         if let APIError::ChannelUnavailable { err } = nodes[1].node.send_payment(route, payment_hash_1).unwrap_err() {
1125                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
1126         } else { panic!("Unexpected event"); }
1127
1128         // This should also be true if we try to forward a payment.
1129         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
1130         let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
1131         nodes[0].node.send_payment(route, payment_hash_2).unwrap();
1132         check_added_monitors!(nodes[0], 1);
1133
1134         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1135         assert_eq!(events.len(), 1);
1136         let payment_event = SendEvent::from_event(events.pop().unwrap());
1137         assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
1138
1139         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
1140         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
1141         // We have to forward pending HTLCs twice - once tries to forward the payment forward (and
1142         // fails), the second will process the resulting failure and fail the HTLC backward.
1143         expect_pending_htlcs_forwardable!(nodes[1]);
1144         expect_pending_htlcs_forwardable!(nodes[1]);
1145         check_added_monitors!(nodes[1], 1);
1146
1147         let bs_fail_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1148         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_fail_updates.update_fail_htlcs[0]).unwrap();
1149         commitment_signed_dance!(nodes[0], nodes[1], bs_fail_updates.commitment_signed, false, true);
1150
1151         let events = nodes[0].node.get_and_clear_pending_msg_events();
1152         assert_eq!(events.len(), 1);
1153         match events[0] {
1154                 MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelUpdateMessage { ref msg }} => {
1155                         assert_eq!(msg.contents.short_channel_id, chan_2.0.contents.short_channel_id);
1156                 },
1157                 _ => panic!("Unexpected event"),
1158         }
1159
1160         let events = nodes[0].node.get_and_clear_pending_events();
1161         assert_eq!(events.len(), 1);
1162         match events[0] {
1163                 Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
1164                         assert_eq!(payment_hash, payment_hash_2);
1165                         assert!(!rejected_by_dest);
1166                 },
1167                 _ => panic!("Unexpected event"),
1168         }
1169
1170         // Now forward all the pending HTLCs and claim them back
1171         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &initial_payment_event.msgs[0]).unwrap();
1172         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &initial_payment_event.commitment_msg).unwrap();
1173         check_added_monitors!(nodes[2], 1);
1174
1175         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1176         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
1177         check_added_monitors!(nodes[1], 1);
1178         let as_updates = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
1179
1180         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed).unwrap();
1181         check_added_monitors!(nodes[1], 1);
1182         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1183
1184         for ref update in as_updates.update_add_htlcs.iter() {
1185                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), update).unwrap();
1186         }
1187         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_updates.commitment_signed).unwrap();
1188         check_added_monitors!(nodes[2], 1);
1189         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
1190         check_added_monitors!(nodes[2], 1);
1191         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
1192
1193         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
1194         check_added_monitors!(nodes[1], 1);
1195         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_commitment_signed).unwrap();
1196         check_added_monitors!(nodes[1], 1);
1197         let as_final_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
1198
1199         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_final_raa).unwrap();
1200         check_added_monitors!(nodes[2], 1);
1201
1202         expect_pending_htlcs_forwardable!(nodes[2]);
1203
1204         let events = nodes[2].node.get_and_clear_pending_events();
1205         assert_eq!(events.len(), payments.len());
1206         for (event, &(_, ref hash)) in events.iter().zip(payments.iter()) {
1207                 match event {
1208                         &Event::PaymentReceived { ref payment_hash, .. } => {
1209                                 assert_eq!(*payment_hash, *hash);
1210                         },
1211                         _ => panic!("Unexpected event"),
1212                 };
1213         }
1214
1215         for (preimage, _) in payments.drain(..) {
1216                 claim_payment(&nodes[1], &[&nodes[2]], preimage, 100_000);
1217         }
1218
1219         send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000, 1_000_000);
1220 }
1221
1222 #[test]
1223 fn duplicate_htlc_test() {
1224         // Test that we accept duplicate payment_hash HTLCs across the network and that
1225         // claiming/failing them are all separate and don't affect each other
1226         let mut nodes = create_network(6, &[None, None, None, None, None, None]);
1227
1228         // Create some initial channels to route via 3 to 4/5 from 0/1/2
1229         create_announced_chan_between_nodes(&nodes, 0, 3, LocalFeatures::new(), LocalFeatures::new());
1230         create_announced_chan_between_nodes(&nodes, 1, 3, LocalFeatures::new(), LocalFeatures::new());
1231         create_announced_chan_between_nodes(&nodes, 2, 3, LocalFeatures::new(), LocalFeatures::new());
1232         create_announced_chan_between_nodes(&nodes, 3, 4, LocalFeatures::new(), LocalFeatures::new());
1233         create_announced_chan_between_nodes(&nodes, 3, 5, LocalFeatures::new(), LocalFeatures::new());
1234
1235         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
1236
1237         *nodes[0].network_payment_count.borrow_mut() -= 1;
1238         assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
1239
1240         *nodes[0].network_payment_count.borrow_mut() -= 1;
1241         assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
1242
1243         claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage, 1_000_000);
1244         fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
1245         claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage, 1_000_000);
1246 }
1247
1248 #[test]
1249 fn test_duplicate_htlc_different_direction_onchain() {
1250         // Test that ChannelMonitor doesn't generate 2 preimage txn
1251         // when we have 2 HTLCs with same preimage that go across a node
1252         // in opposite directions.
1253         let nodes = create_network(2, &[None, None]);
1254
1255         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
1256
1257         // balancing
1258         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1259
1260         let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1])[..], 900_000);
1261
1262         let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800_000, TEST_FINAL_CLTV).unwrap();
1263         send_along_route_with_hash(&nodes[1], route, &vec!(&nodes[0])[..], 800_000, payment_hash);
1264
1265         // Provide preimage to node 0 by claiming payment
1266         nodes[0].node.claim_funds(payment_preimage, 800_000);
1267         check_added_monitors!(nodes[0], 1);
1268
1269         // Broadcast node 1 commitment txn
1270         let remote_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
1271
1272         assert_eq!(remote_txn[0].output.len(), 4); // 1 local, 1 remote, 1 htlc inbound, 1 htlc outbound
1273         let mut has_both_htlcs = 0; // check htlcs match ones committed
1274         for outp in remote_txn[0].output.iter() {
1275                 if outp.value == 800_000 / 1000 {
1276                         has_both_htlcs += 1;
1277                 } else if outp.value == 900_000 / 1000 {
1278                         has_both_htlcs += 1;
1279                 }
1280         }
1281         assert_eq!(has_both_htlcs, 2);
1282
1283         let header = BlockHeader { version: 0x2000_0000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1284         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![remote_txn[0].clone()] }, 1);
1285
1286         // Check we only broadcast 1 timeout tx
1287         let claim_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
1288         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()) };
1289         assert_eq!(claim_txn.len(), 6);
1290         assert_eq!(htlc_pair.0.input.len(), 1);
1291         assert_eq!(htlc_pair.0.input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC 1 <--> 0, preimage tx
1292         check_spends!(htlc_pair.0, remote_txn[0].clone());
1293         assert_eq!(htlc_pair.1.input.len(), 1);
1294         assert_eq!(htlc_pair.1.input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // HTLC 0 <--> 1, timeout tx
1295         check_spends!(htlc_pair.1, remote_txn[0].clone());
1296
1297         let events = nodes[0].node.get_and_clear_pending_msg_events();
1298         assert_eq!(events.len(), 2);
1299         for e in events {
1300                 match e {
1301                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
1302                         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, .. } } => {
1303                                 assert!(update_add_htlcs.is_empty());
1304                                 assert!(update_fail_htlcs.is_empty());
1305                                 assert_eq!(update_fulfill_htlcs.len(), 1);
1306                                 assert!(update_fail_malformed_htlcs.is_empty());
1307                                 assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
1308                         },
1309                         _ => panic!("Unexpected event"),
1310                 }
1311         }
1312 }
1313
1314 fn do_channel_reserve_test(test_recv: bool) {
1315         use ln::msgs::LightningError;
1316
1317         let mut nodes = create_network(3, &[None, None, None]);
1318         let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001, LocalFeatures::new(), LocalFeatures::new());
1319         let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001, LocalFeatures::new(), LocalFeatures::new());
1320
1321         let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
1322         let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
1323
1324         let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
1325         let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
1326
1327         macro_rules! get_route_and_payment_hash {
1328                 ($recv_value: expr) => {{
1329                         let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
1330                         let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
1331                         (route, payment_hash, payment_preimage)
1332                 }}
1333         };
1334
1335         macro_rules! expect_forward {
1336                 ($node: expr) => {{
1337                         let mut events = $node.node.get_and_clear_pending_msg_events();
1338                         assert_eq!(events.len(), 1);
1339                         check_added_monitors!($node, 1);
1340                         let payment_event = SendEvent::from_event(events.remove(0));
1341                         payment_event
1342                 }}
1343         }
1344
1345         let feemsat = 239; // somehow we know?
1346         let total_fee_msat = (nodes.len() - 2) as u64 * 239;
1347
1348         let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
1349
1350         // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
1351         {
1352                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
1353                 assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
1354                 let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
1355                 match err {
1356                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept"),
1357                         _ => panic!("Unknown error variants"),
1358                 }
1359         }
1360
1361         let mut htlc_id = 0;
1362         // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
1363         // nodes[0]'s wealth
1364         loop {
1365                 let amt_msat = recv_value_0 + total_fee_msat;
1366                 if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
1367                         break;
1368                 }
1369                 send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0, recv_value_0);
1370                 htlc_id += 1;
1371
1372                 let (stat01_, stat11_, stat12_, stat22_) = (
1373                         get_channel_value_stat!(nodes[0], chan_1.2),
1374                         get_channel_value_stat!(nodes[1], chan_1.2),
1375                         get_channel_value_stat!(nodes[1], chan_2.2),
1376                         get_channel_value_stat!(nodes[2], chan_2.2),
1377                 );
1378
1379                 assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
1380                 assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
1381                 assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
1382                 assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
1383                 stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
1384         }
1385
1386         {
1387                 let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
1388                 // attempt to get channel_reserve violation
1389                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
1390                 let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
1391                 match err {
1392                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1393                         _ => panic!("Unknown error variants"),
1394                 }
1395         }
1396
1397         // adding pending output
1398         let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
1399         let amt_msat_1 = recv_value_1 + total_fee_msat;
1400
1401         let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
1402         let payment_event_1 = {
1403                 nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
1404                 check_added_monitors!(nodes[0], 1);
1405
1406                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1407                 assert_eq!(events.len(), 1);
1408                 SendEvent::from_event(events.remove(0))
1409         };
1410         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
1411
1412         // channel reserve test with htlc pending output > 0
1413         let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
1414         {
1415                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1416                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1417                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1418                         _ => panic!("Unknown error variants"),
1419                 }
1420         }
1421
1422         {
1423                 // test channel_reserve test on nodes[1] side
1424                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
1425
1426                 // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
1427                 let secp_ctx = Secp256k1::new();
1428                 let session_priv = SecretKey::from_slice(&{
1429                         let mut session_key = [0; 32];
1430                         let mut rng = thread_rng();
1431                         rng.fill_bytes(&mut session_key);
1432                         session_key
1433                 }).expect("RNG is bad!");
1434
1435                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1436                 let onion_keys = onion_utils::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
1437                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
1438                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
1439                 let msg = msgs::UpdateAddHTLC {
1440                         channel_id: chan_1.2,
1441                         htlc_id,
1442                         amount_msat: htlc_msat,
1443                         payment_hash: our_payment_hash,
1444                         cltv_expiry: htlc_cltv,
1445                         onion_routing_packet: onion_packet,
1446                 };
1447
1448                 if test_recv {
1449                         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
1450                         match err {
1451                                 LightningError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
1452                         }
1453                         // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
1454                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1455                         assert_eq!(nodes[1].node.list_channels().len(), 1);
1456                         check_closed_broadcast!(nodes[1]);
1457                         return;
1458                 }
1459         }
1460
1461         // split the rest to test holding cell
1462         let recv_value_21 = recv_value_2/2;
1463         let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
1464         {
1465                 let stat = get_channel_value_stat!(nodes[0], chan_1.2);
1466                 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);
1467         }
1468
1469         // now see if they go through on both sides
1470         let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
1471         // but this will stuck in the holding cell
1472         nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
1473         check_added_monitors!(nodes[0], 0);
1474         let events = nodes[0].node.get_and_clear_pending_events();
1475         assert_eq!(events.len(), 0);
1476
1477         // test with outbound holding cell amount > 0
1478         {
1479                 let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
1480                 match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
1481                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over their reserve value"),
1482                         _ => panic!("Unknown error variants"),
1483                 }
1484         }
1485
1486         let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
1487         // this will also stuck in the holding cell
1488         nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
1489         check_added_monitors!(nodes[0], 0);
1490         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
1491         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
1492
1493         // flush the pending htlc
1494         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
1495         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1496         check_added_monitors!(nodes[1], 1);
1497
1498         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
1499         check_added_monitors!(nodes[0], 1);
1500         let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1501
1502         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed).unwrap();
1503         let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1504         // No commitment_signed so get_event_msg's assert(len == 1) passes
1505         check_added_monitors!(nodes[0], 1);
1506
1507         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
1508         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1509         check_added_monitors!(nodes[1], 1);
1510
1511         expect_pending_htlcs_forwardable!(nodes[1]);
1512
1513         let ref payment_event_11 = expect_forward!(nodes[1]);
1514         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
1515         commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
1516
1517         expect_pending_htlcs_forwardable!(nodes[2]);
1518         expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
1519
1520         // flush the htlcs in the holding cell
1521         assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
1522         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
1523         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
1524         commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
1525         expect_pending_htlcs_forwardable!(nodes[1]);
1526
1527         let ref payment_event_3 = expect_forward!(nodes[1]);
1528         assert_eq!(payment_event_3.msgs.len(), 2);
1529         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
1530         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
1531
1532         commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
1533         expect_pending_htlcs_forwardable!(nodes[2]);
1534
1535         let events = nodes[2].node.get_and_clear_pending_events();
1536         assert_eq!(events.len(), 2);
1537         match events[0] {
1538                 Event::PaymentReceived { ref payment_hash, amt } => {
1539                         assert_eq!(our_payment_hash_21, *payment_hash);
1540                         assert_eq!(recv_value_21, amt);
1541                 },
1542                 _ => panic!("Unexpected event"),
1543         }
1544         match events[1] {
1545                 Event::PaymentReceived { ref payment_hash, amt } => {
1546                         assert_eq!(our_payment_hash_22, *payment_hash);
1547                         assert_eq!(recv_value_22, amt);
1548                 },
1549                 _ => panic!("Unexpected event"),
1550         }
1551
1552         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1, recv_value_1);
1553         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21, recv_value_21);
1554         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22, recv_value_22);
1555
1556         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);
1557         let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
1558         assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
1559         assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
1560
1561         let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
1562         assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
1563 }
1564
1565 #[test]
1566 fn channel_reserve_test() {
1567         do_channel_reserve_test(false);
1568         do_channel_reserve_test(true);
1569 }
1570
1571 #[test]
1572 fn channel_reserve_in_flight_removes() {
1573         // In cases where one side claims an HTLC, it thinks it has additional available funds that it
1574         // can send to its counterparty, but due to update ordering, the other side may not yet have
1575         // considered those HTLCs fully removed.
1576         // This tests that we don't count HTLCs which will not be included in the next remote
1577         // commitment transaction towards the reserve value (as it implies no commitment transaction
1578         // will be generated which violates the remote reserve value).
1579         // This was broken previously, and discovered by the chanmon_fail_consistency fuzz test.
1580         // To test this we:
1581         //  * route two HTLCs from A to B (note that, at a high level, this test is checking that, when
1582         //    you consider the values of both of these HTLCs, B may not send an HTLC back to A, but if
1583         //    you only consider the value of the first HTLC, it may not),
1584         //  * start routing a third HTLC from A to B,
1585         //  * claim the first two HTLCs (though B will generate an update_fulfill for one, and put
1586         //    the other claim in its holding cell, as it immediately goes into AwaitingRAA),
1587         //  * deliver the first fulfill from B
1588         //  * deliver the update_add and an RAA from A, resulting in B freeing the second holding cell
1589         //    claim,
1590         //  * deliver A's response CS and RAA.
1591         //    This results in A having the second HTLC in AwaitingRemovedRemoteRevoke, but B having
1592         //    removed it fully. B now has the push_msat plus the first two HTLCs in value.
1593         //  * Now B happily sends another HTLC, potentially violating its reserve value from A's point
1594         //    of view (if A counts the AwaitingRemovedRemoteRevoke HTLC).
1595         let mut nodes = create_network(2, &[None, None]);
1596         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
1597
1598         let b_chan_values = get_channel_value_stat!(nodes[1], chan_1.2);
1599         // Route the first two HTLCs.
1600         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000);
1601         let (payment_preimage_2, _) = route_payment(&nodes[0], &[&nodes[1]], 20000);
1602
1603         // Start routing the third HTLC (this is just used to get everyone in the right state).
1604         let (payment_preimage_3, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
1605         let send_1 = {
1606                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
1607                 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
1608                 check_added_monitors!(nodes[0], 1);
1609                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
1610                 assert_eq!(events.len(), 1);
1611                 SendEvent::from_event(events.remove(0))
1612         };
1613
1614         // Now claim both of the first two HTLCs on B's end, putting B in AwaitingRAA and generating an
1615         // initial fulfill/CS.
1616         assert!(nodes[1].node.claim_funds(payment_preimage_1, b_chan_values.channel_reserve_msat - b_chan_values.value_to_self_msat - 10000));
1617         check_added_monitors!(nodes[1], 1);
1618         let bs_removes = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1619
1620         // This claim goes in B's holding cell, allowing us to have a pending B->A RAA which does not
1621         // remove the second HTLC when we send the HTLC back from B to A.
1622         assert!(nodes[1].node.claim_funds(payment_preimage_2, 20000));
1623         check_added_monitors!(nodes[1], 1);
1624         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1625
1626         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_removes.update_fulfill_htlcs[0]).unwrap();
1627         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_removes.commitment_signed).unwrap();
1628         check_added_monitors!(nodes[0], 1);
1629         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1630         expect_payment_sent!(nodes[0], payment_preimage_1);
1631
1632         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_1.msgs[0]).unwrap();
1633         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_1.commitment_msg).unwrap();
1634         check_added_monitors!(nodes[1], 1);
1635         // B is already AwaitingRAA, so cant generate a CS here
1636         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1637
1638         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa).unwrap();
1639         check_added_monitors!(nodes[1], 1);
1640         let bs_cs = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
1641
1642         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa).unwrap();
1643         check_added_monitors!(nodes[0], 1);
1644         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1645
1646         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
1647         check_added_monitors!(nodes[1], 1);
1648         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1649
1650         // The second HTLCis removed, but as A is in AwaitingRAA it can't generate a CS here, so the
1651         // RAA that B generated above doesn't fully resolve the second HTLC from A's point of view.
1652         // However, the RAA A generates here *does* fully resolve the HTLC from B's point of view (as A
1653         // can no longer broadcast a commitment transaction with it and B has the preimage so can go
1654         // on-chain as necessary).
1655         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_cs.update_fulfill_htlcs[0]).unwrap();
1656         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_cs.commitment_signed).unwrap();
1657         check_added_monitors!(nodes[0], 1);
1658         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1659         expect_payment_sent!(nodes[0], payment_preimage_2);
1660
1661         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa).unwrap();
1662         check_added_monitors!(nodes[1], 1);
1663         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
1664
1665         expect_pending_htlcs_forwardable!(nodes[1]);
1666         expect_payment_received!(nodes[1], payment_hash_3, 100000);
1667
1668         // Note that as this RAA was generated before the delivery of the update_fulfill it shouldn't
1669         // resolve the second HTLC from A's point of view.
1670         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa).unwrap();
1671         check_added_monitors!(nodes[0], 1);
1672         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1673
1674         // Now that B doesn't have the second RAA anymore, but A still does, send a payment from B back
1675         // to A to ensure that A doesn't count the almost-removed HTLC in update_add processing.
1676         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[1]);
1677         let send_2 = {
1678                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 10000, TEST_FINAL_CLTV).unwrap();
1679                 nodes[1].node.send_payment(route, payment_hash_4).unwrap();
1680                 check_added_monitors!(nodes[1], 1);
1681                 let mut events = nodes[1].node.get_and_clear_pending_msg_events();
1682                 assert_eq!(events.len(), 1);
1683                 SendEvent::from_event(events.remove(0))
1684         };
1685
1686         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_2.msgs[0]).unwrap();
1687         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_2.commitment_msg).unwrap();
1688         check_added_monitors!(nodes[0], 1);
1689         let as_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
1690
1691         // Now just resolve all the outstanding messages/HTLCs for completeness...
1692
1693         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
1694         check_added_monitors!(nodes[1], 1);
1695         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1696
1697         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_raa).unwrap();
1698         check_added_monitors!(nodes[1], 1);
1699
1700         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa).unwrap();
1701         check_added_monitors!(nodes[0], 1);
1702         let as_cs = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
1703
1704         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
1705         check_added_monitors!(nodes[1], 1);
1706         let bs_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
1707
1708         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_raa).unwrap();
1709         check_added_monitors!(nodes[0], 1);
1710
1711         expect_pending_htlcs_forwardable!(nodes[0]);
1712         expect_payment_received!(nodes[0], payment_hash_4, 10000);
1713
1714         claim_payment(&nodes[1], &[&nodes[0]], payment_preimage_4, 10_000);
1715         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_3, 100_000);
1716 }
1717
1718 #[test]
1719 fn channel_monitor_network_test() {
1720         // Simple test which builds a network of ChannelManagers, connects them to each other, and
1721         // tests that ChannelMonitor is able to recover from various states.
1722         let nodes = create_network(5, &[None, None, None, None, None]);
1723
1724         // Create some initial channels
1725         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
1726         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
1727         let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3, LocalFeatures::new(), LocalFeatures::new());
1728         let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4, LocalFeatures::new(), LocalFeatures::new());
1729
1730         // Rebalance the network a bit by relaying one payment through all the channels...
1731         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1732         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1733         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1734         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000, 8_000_000);
1735
1736         // Simple case with no pending HTLCs:
1737         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
1738         {
1739                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
1740                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1741                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1742                 test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
1743         }
1744         get_announce_close_broadcast_events(&nodes, 0, 1);
1745         assert_eq!(nodes[0].node.list_channels().len(), 0);
1746         assert_eq!(nodes[1].node.list_channels().len(), 1);
1747
1748         // One pending HTLC is discarded by the force-close:
1749         let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
1750
1751         // Simple case of one pending HTLC to HTLC-Timeout
1752         nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
1753         {
1754                 let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
1755                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1756                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
1757                 test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
1758         }
1759         get_announce_close_broadcast_events(&nodes, 1, 2);
1760         assert_eq!(nodes[1].node.list_channels().len(), 0);
1761         assert_eq!(nodes[2].node.list_channels().len(), 1);
1762
1763         macro_rules! claim_funds {
1764                 ($node: expr, $prev_node: expr, $preimage: expr, $amount: expr) => {
1765                         {
1766                                 assert!($node.node.claim_funds($preimage, $amount));
1767                                 check_added_monitors!($node, 1);
1768
1769                                 let events = $node.node.get_and_clear_pending_msg_events();
1770                                 assert_eq!(events.len(), 1);
1771                                 match events[0] {
1772                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
1773                                                 assert!(update_add_htlcs.is_empty());
1774                                                 assert!(update_fail_htlcs.is_empty());
1775                                                 assert_eq!(*node_id, $prev_node.node.get_our_node_id());
1776                                         },
1777                                         _ => panic!("Unexpected event"),
1778                                 };
1779                         }
1780                 }
1781         }
1782
1783         // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
1784         // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
1785         nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
1786         {
1787                 let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
1788
1789                 // Claim the payment on nodes[3], giving it knowledge of the preimage
1790                 claim_funds!(nodes[3], nodes[2], payment_preimage_1, 3_000_000);
1791
1792                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1793                 nodes[3].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
1794
1795                 check_preimage_claim(&nodes[3], &node_txn);
1796         }
1797         get_announce_close_broadcast_events(&nodes, 2, 3);
1798         assert_eq!(nodes[2].node.list_channels().len(), 0);
1799         assert_eq!(nodes[3].node.list_channels().len(), 1);
1800
1801         { // Cheat and reset nodes[4]'s height to 1
1802                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1803                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![] }, 1);
1804         }
1805
1806         assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
1807         assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
1808         // One pending HTLC to time out:
1809         let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
1810         // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
1811         // buffer space).
1812
1813         {
1814                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1815                 nodes[3].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1816                 for i in 3..TEST_FINAL_CLTV + 2 + LATENCY_GRACE_PERIOD_BLOCKS + 1 {
1817                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1818                         nodes[3].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1819                 }
1820
1821                 let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
1822
1823                 // Claim the payment on nodes[4], giving it knowledge of the preimage
1824                 claim_funds!(nodes[4], nodes[3], payment_preimage_2, 3_000_000);
1825
1826                 header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1827
1828                 nodes[4].block_notifier.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
1829                 for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
1830                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1831                         nodes[4].block_notifier.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
1832                 }
1833
1834                 test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
1835
1836                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1837                 nodes[4].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
1838
1839                 check_preimage_claim(&nodes[4], &node_txn);
1840         }
1841         get_announce_close_broadcast_events(&nodes, 3, 4);
1842         assert_eq!(nodes[3].node.list_channels().len(), 0);
1843         assert_eq!(nodes[4].node.list_channels().len(), 0);
1844 }
1845
1846 #[test]
1847 fn test_justice_tx() {
1848         // Test justice txn built on revoked HTLC-Success tx, against both sides
1849         let mut alice_config = UserConfig::new();
1850         alice_config.channel_options.announced_channel = true;
1851         alice_config.peer_channel_config_limits.force_announced_channel_preference = false;
1852         alice_config.own_channel_config.our_to_self_delay = 6 * 24 * 5;
1853         let mut bob_config = UserConfig::new();
1854         bob_config.channel_options.announced_channel = true;
1855         bob_config.peer_channel_config_limits.force_announced_channel_preference = false;
1856         bob_config.own_channel_config.our_to_self_delay = 6 * 24 * 3;
1857         let cfgs = [Some(alice_config), Some(bob_config)];
1858         let nodes = create_network(2, &cfgs);
1859         // Create some new channels:
1860         let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
1861
1862         // A pending HTLC which will be revoked:
1863         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1864         // Get the will-be-revoked local txn from nodes[0]
1865         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
1866         assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
1867         assert_eq!(revoked_local_txn[0].input.len(), 1);
1868         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
1869         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
1870         assert_eq!(revoked_local_txn[1].input.len(), 1);
1871         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1872         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1873         // Revoke the old state
1874         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 3_000_000);
1875
1876         {
1877                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1878                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1879                 {
1880                         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1881                         assert_eq!(node_txn.len(), 3);
1882                         assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1883                         assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
1884
1885                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
1886                         node_txn.swap_remove(0);
1887                 }
1888                 test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
1889
1890                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1891                 let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
1892                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1893                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1894                 test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
1895         }
1896         get_announce_close_broadcast_events(&nodes, 0, 1);
1897
1898         assert_eq!(nodes[0].node.list_channels().len(), 0);
1899         assert_eq!(nodes[1].node.list_channels().len(), 0);
1900
1901         // We test justice_tx build by A on B's revoked HTLC-Success tx
1902         // Create some new channels:
1903         let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
1904
1905         // A pending HTLC which will be revoked:
1906         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1907         // Get the will-be-revoked local txn from B
1908         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
1909         assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
1910         assert_eq!(revoked_local_txn[0].input.len(), 1);
1911         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
1912         assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
1913         // Revoke the old state
1914         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4, 3_000_000);
1915         {
1916                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1917                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1918                 {
1919                         let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
1920                         assert_eq!(node_txn.len(), 3);
1921                         assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
1922                         assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
1923
1924                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
1925                         node_txn.swap_remove(0);
1926                 }
1927                 test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
1928
1929                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1930                 let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
1931                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1932                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
1933                 test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone());
1934         }
1935         get_announce_close_broadcast_events(&nodes, 0, 1);
1936         assert_eq!(nodes[0].node.list_channels().len(), 0);
1937         assert_eq!(nodes[1].node.list_channels().len(), 0);
1938 }
1939
1940 #[test]
1941 fn revoked_output_claim() {
1942         // Simple test to ensure a node will claim a revoked output when a stale remote commitment
1943         // transaction is broadcast by its counterparty
1944         let nodes = create_network(2, &[None, None]);
1945         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
1946         // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
1947         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
1948         assert_eq!(revoked_local_txn.len(), 1);
1949         // Only output is the full channel value back to nodes[0]:
1950         assert_eq!(revoked_local_txn[0].output.len(), 1);
1951         // Send a payment through, updating everyone's latest commitment txn
1952         send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000, 5_000_000);
1953
1954         // Inform nodes[1] that nodes[0] broadcast a stale tx
1955         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1956         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1957         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
1958         assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
1959
1960         assert_eq!(node_txn[0], node_txn[2]);
1961
1962         check_spends!(node_txn[0], revoked_local_txn[0].clone());
1963         check_spends!(node_txn[1], chan_1.3.clone());
1964
1965         // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
1966         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
1967         get_announce_close_broadcast_events(&nodes, 0, 1);
1968 }
1969
1970 #[test]
1971 fn claim_htlc_outputs_shared_tx() {
1972         // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
1973         let nodes = create_network(2, &[None, None]);
1974
1975         // Create some new channel:
1976         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
1977
1978         // Rebalance the network to generate htlc in the two directions
1979         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
1980         // 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
1981         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
1982         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
1983
1984         // Get the will-be-revoked local txn from node[0]
1985         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
1986         assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
1987         assert_eq!(revoked_local_txn[0].input.len(), 1);
1988         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
1989         assert_eq!(revoked_local_txn[1].input.len(), 1);
1990         assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
1991         assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT); // HTLC-Timeout
1992         check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
1993
1994         //Revoke the old state
1995         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
1996
1997         {
1998                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
1999                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2000                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2001                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2002
2003                 let events = nodes[1].node.get_and_clear_pending_events();
2004                 assert_eq!(events.len(), 1);
2005                 match events[0] {
2006                         Event::PaymentFailed { payment_hash, .. } => {
2007                                 assert_eq!(payment_hash, payment_hash_2);
2008                         },
2009                         _ => panic!("Unexpected event"),
2010                 }
2011
2012                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2013                 assert_eq!(node_txn.len(), 4);
2014
2015                 assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
2016                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
2017
2018                 assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
2019
2020                 let mut witness_lens = BTreeSet::new();
2021                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2022                 witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
2023                 witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
2024                 assert_eq!(witness_lens.len(), 3);
2025                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2026                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2027                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2028
2029                 // Next nodes[1] broadcasts its current local tx state:
2030                 assert_eq!(node_txn[1].input.len(), 1);
2031                 assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
2032
2033                 assert_eq!(node_txn[2].input.len(), 1);
2034                 let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
2035                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2036                 assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
2037                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2038                 assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
2039         }
2040         get_announce_close_broadcast_events(&nodes, 0, 1);
2041         assert_eq!(nodes[0].node.list_channels().len(), 0);
2042         assert_eq!(nodes[1].node.list_channels().len(), 0);
2043 }
2044
2045 #[test]
2046 fn claim_htlc_outputs_single_tx() {
2047         // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
2048         let nodes = create_network(2, &[None, None]);
2049
2050         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
2051
2052         // Rebalance the network to generate htlc in the two directions
2053         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
2054         // 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
2055         // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
2056         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
2057         let (_payment_preimage_2, payment_hash_2) = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000);
2058
2059         // Get the will-be-revoked local txn from node[0]
2060         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2061
2062         //Revoke the old state
2063         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1, 3_000_000);
2064
2065         {
2066                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2067                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2068                 nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
2069                 connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
2070
2071                 let events = nodes[1].node.get_and_clear_pending_events();
2072                 assert_eq!(events.len(), 1);
2073                 match events[0] {
2074                         Event::PaymentFailed { payment_hash, .. } => {
2075                                 assert_eq!(payment_hash, payment_hash_2);
2076                         },
2077                         _ => panic!("Unexpected event"),
2078                 }
2079
2080                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2081                 assert_eq!(node_txn.len(), 22); // ChannelManager : 2, ChannelMontitor: 8 (1 standard revoked output, 2 revocation htlc tx, 1 local commitment tx + 1 htlc timeout tx) * 2 (block-rescan) + 5 * (1 local commitment tx + 1 htlc timeout tx)
2082
2083                 assert_eq!(node_txn[0], node_txn[7]);
2084                 assert_eq!(node_txn[1], node_txn[8]);
2085                 assert_eq!(node_txn[2], node_txn[9]);
2086                 assert_eq!(node_txn[3], node_txn[10]);
2087                 assert_eq!(node_txn[4], node_txn[11]);
2088                 assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcasted by ChannelManger
2089                 assert_eq!(node_txn[4], node_txn[6]);
2090
2091                 for i in 12..22 {
2092                         if i % 2 == 0 { assert_eq!(node_txn[3], node_txn[i]); } else { assert_eq!(node_txn[4], node_txn[i]); }
2093                 }
2094
2095                 assert_eq!(node_txn[0].input.len(), 1);
2096                 assert_eq!(node_txn[1].input.len(), 1);
2097                 assert_eq!(node_txn[2].input.len(), 1);
2098
2099                 fn get_txout(out_point: &BitcoinOutPoint, tx: &Transaction) -> Option<TxOut> {
2100                         if out_point.txid == tx.txid() {
2101                                 tx.output.get(out_point.vout as usize).cloned()
2102                         } else {
2103                                 None
2104                         }
2105                 }
2106                 node_txn[0].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2107                 node_txn[1].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2108                 node_txn[2].verify(|out|get_txout(out, &revoked_local_txn[0])).unwrap();
2109
2110                 let mut witness_lens = BTreeSet::new();
2111                 witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
2112                 witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
2113                 witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
2114                 assert_eq!(witness_lens.len(), 3);
2115                 assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
2116                 assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), OFFERED_HTLC_SCRIPT_WEIGHT); // revoked offered HTLC
2117                 assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), ACCEPTED_HTLC_SCRIPT_WEIGHT); // revoked received HTLC
2118
2119                 assert_eq!(node_txn[3].input.len(), 1);
2120                 check_spends!(node_txn[3], chan_1.3.clone());
2121
2122                 assert_eq!(node_txn[4].input.len(), 1);
2123                 let witness_script = node_txn[4].input[0].witness.last().unwrap();
2124                 assert_eq!(witness_script.len(), OFFERED_HTLC_SCRIPT_WEIGHT); //Spending an offered htlc output
2125                 assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
2126                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
2127                 assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
2128         }
2129         get_announce_close_broadcast_events(&nodes, 0, 1);
2130         assert_eq!(nodes[0].node.list_channels().len(), 0);
2131         assert_eq!(nodes[1].node.list_channels().len(), 0);
2132 }
2133
2134 #[test]
2135 fn test_htlc_on_chain_success() {
2136         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2137         // ChainWatchInterface and pass the preimage backward accordingly. So here we test that ChannelManager is
2138         // broadcasting the right event to other nodes in payment path.
2139         // We test with two HTLCs simultaneously as that was not handled correctly in the past.
2140         // A --------------------> B ----------------------> C (preimage)
2141         // First, C should claim the HTLC outputs via HTLC-Success when its own latest local
2142         // commitment transaction was broadcast.
2143         // Then, B should learn the preimage from said transactions, attempting to claim backwards
2144         // towards B.
2145         // B should be able to claim via preimage if A then broadcasts its local tx.
2146         // Finally, when A sees B's latest local commitment transaction it should be able to claim
2147         // the HTLC outputs via the preimage it learned (which, once confirmed should generate a
2148         // PaymentSent event).
2149
2150         let nodes = create_network(3, &[None, None, None]);
2151
2152         // Create some initial channels
2153         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
2154         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
2155
2156         // Rebalance the network a bit by relaying one payment through all the channels...
2157         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2158         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2159
2160         let (our_payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2161         let (our_payment_preimage_2, _payment_hash_2) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2162         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2163
2164         // Broadcast legit commitment tx from C on B's chain
2165         // Broadcast HTLC Success transaction by C on received output from C's commitment tx on B's chain
2166         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2167         assert_eq!(commitment_tx.len(), 1);
2168         check_spends!(commitment_tx[0], chan_2.3.clone());
2169         nodes[2].node.claim_funds(our_payment_preimage, 3_000_000);
2170         nodes[2].node.claim_funds(our_payment_preimage_2, 3_000_000);
2171         check_added_monitors!(nodes[2], 2);
2172         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2173         assert!(updates.update_add_htlcs.is_empty());
2174         assert!(updates.update_fail_htlcs.is_empty());
2175         assert!(updates.update_fail_malformed_htlcs.is_empty());
2176         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2177
2178         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2179         check_closed_broadcast!(nodes[2]);
2180         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 4 (2*2 * HTLC-Success tx)
2181         assert_eq!(node_txn.len(), 5);
2182         assert_eq!(node_txn[0], node_txn[3]);
2183         assert_eq!(node_txn[1], node_txn[4]);
2184         assert_eq!(node_txn[2], commitment_tx[0]);
2185         check_spends!(node_txn[0], commitment_tx[0].clone());
2186         check_spends!(node_txn[1], commitment_tx[0].clone());
2187         assert_eq!(node_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2188         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2189         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2190         assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2191         assert_eq!(node_txn[0].lock_time, 0);
2192         assert_eq!(node_txn[1].lock_time, 0);
2193
2194         // Verify that B's ChannelManager is able to extract preimage from HTLC Success tx and pass it backward
2195         nodes[1].block_notifier.block_connected(&Block { header, txdata: node_txn}, 1);
2196         let events = nodes[1].node.get_and_clear_pending_msg_events();
2197         {
2198                 let mut added_monitors = nodes[1].chan_monitor.added_monitors.lock().unwrap();
2199                 assert_eq!(added_monitors.len(), 2);
2200                 assert_eq!(added_monitors[0].0.txid, chan_1.3.txid());
2201                 assert_eq!(added_monitors[1].0.txid, chan_1.3.txid());
2202                 added_monitors.clear();
2203         }
2204         assert_eq!(events.len(), 2);
2205         match events[0] {
2206                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
2207                 _ => panic!("Unexpected event"),
2208         }
2209         match events[1] {
2210                 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, .. } } => {
2211                         assert!(update_add_htlcs.is_empty());
2212                         assert!(update_fail_htlcs.is_empty());
2213                         assert_eq!(update_fulfill_htlcs.len(), 1);
2214                         assert!(update_fail_malformed_htlcs.is_empty());
2215                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2216                 },
2217                 _ => panic!("Unexpected event"),
2218         };
2219         macro_rules! check_tx_local_broadcast {
2220                 ($node: expr, $htlc_offered: expr, $commitment_tx: expr, $chan_tx: expr) => { {
2221                         // ChannelManager : 3 (commitment tx, 2*HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 (block-rescan)
2222                         let mut node_txn = $node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2223                         assert_eq!(node_txn.len(), 7);
2224                         assert_eq!(node_txn[0], node_txn[5]);
2225                         assert_eq!(node_txn[1], node_txn[6]);
2226                         check_spends!(node_txn[0], $commitment_tx.clone());
2227                         check_spends!(node_txn[1], $commitment_tx.clone());
2228                         assert_ne!(node_txn[0].lock_time, 0);
2229                         assert_ne!(node_txn[1].lock_time, 0);
2230                         if $htlc_offered {
2231                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2232                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2233                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2234                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2235                         } else {
2236                                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2237                                 assert_eq!(node_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2238                                 assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2239                                 assert!(node_txn[1].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2240                         }
2241                         check_spends!(node_txn[2], $chan_tx.clone());
2242                         check_spends!(node_txn[3], node_txn[2].clone());
2243                         check_spends!(node_txn[4], node_txn[2].clone());
2244                         assert_eq!(node_txn[2].input[0].witness.last().unwrap().len(), 71);
2245                         assert_eq!(node_txn[3].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2246                         assert_eq!(node_txn[4].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2247                         assert!(node_txn[3].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2248                         assert!(node_txn[4].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
2249                         assert_ne!(node_txn[3].lock_time, 0);
2250                         assert_ne!(node_txn[4].lock_time, 0);
2251                         node_txn.clear();
2252                 } }
2253         }
2254         // nodes[1] now broadcasts its own local state as a fallback, suggesting an alternate
2255         // commitment transaction with a corresponding HTLC-Timeout transactions, as well as a
2256         // timeout-claim of the output that nodes[2] just claimed via success.
2257         check_tx_local_broadcast!(nodes[1], false, commitment_tx[0], chan_2.3);
2258
2259         // Broadcast legit commitment tx from A on B's chain
2260         // Broadcast preimage tx by B on offered output from A commitment tx  on A's chain
2261         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2262         check_spends!(commitment_tx[0], chan_1.3.clone());
2263         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2264         check_closed_broadcast!(nodes[1]);
2265         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx), ChannelMonitor : 1 (HTLC-Success) * 2 (block-rescan)
2266         assert_eq!(node_txn.len(), 3);
2267         assert_eq!(node_txn[0], node_txn[2]);
2268         check_spends!(node_txn[0], commitment_tx[0].clone());
2269         assert_eq!(node_txn[0].input.len(), 2);
2270         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2271         assert_eq!(node_txn[0].input[1].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2272         assert_eq!(node_txn[0].lock_time, 0);
2273         assert!(node_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
2274         check_spends!(node_txn[1], chan_1.3.clone());
2275         assert_eq!(node_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
2276         // We don't bother to check that B can claim the HTLC output on its commitment tx here as
2277         // we already checked the same situation with A.
2278
2279         // Verify that A's ChannelManager is able to extract preimage from preimage tx and generate PaymentSent
2280         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone(), node_txn[0].clone()] }, 1);
2281         check_closed_broadcast!(nodes[0]);
2282         let events = nodes[0].node.get_and_clear_pending_events();
2283         assert_eq!(events.len(), 2);
2284         let mut first_claimed = false;
2285         for event in events {
2286                 match event {
2287                         Event::PaymentSent { payment_preimage } => {
2288                                 if payment_preimage == our_payment_preimage {
2289                                         assert!(!first_claimed);
2290                                         first_claimed = true;
2291                                 } else {
2292                                         assert_eq!(payment_preimage, our_payment_preimage_2);
2293                                 }
2294                         },
2295                         _ => panic!("Unexpected event"),
2296                 }
2297         }
2298         check_tx_local_broadcast!(nodes[0], true, commitment_tx[0], chan_1.3);
2299 }
2300
2301 #[test]
2302 fn test_htlc_on_chain_timeout() {
2303         // Test that in case of a unilateral close onchain, we detect the state of output thanks to
2304         // ChainWatchInterface and timeout the HTLC backward accordingly. So here we test that ChannelManager is
2305         // broadcasting the right event to other nodes in payment path.
2306         // A ------------------> B ----------------------> C (timeout)
2307         //    B's commitment tx                 C's commitment tx
2308         //            \                                  \
2309         //         B's HTLC timeout tx               B's timeout tx
2310
2311         let nodes = create_network(3, &[None, None, None]);
2312
2313         // Create some intial channels
2314         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
2315         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
2316
2317         // Rebalance the network a bit by relaying one payment thorugh all the channels...
2318         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2319         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
2320
2321         let (_payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
2322         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2323
2324         // Broadcast legit commitment tx from C on B's chain
2325         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2326         check_spends!(commitment_tx[0], chan_2.3.clone());
2327         nodes[2].node.fail_htlc_backwards(&payment_hash);
2328         check_added_monitors!(nodes[2], 0);
2329         expect_pending_htlcs_forwardable!(nodes[2]);
2330         check_added_monitors!(nodes[2], 1);
2331
2332         let events = nodes[2].node.get_and_clear_pending_msg_events();
2333         assert_eq!(events.len(), 1);
2334         match events[0] {
2335                 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, .. } } => {
2336                         assert!(update_add_htlcs.is_empty());
2337                         assert!(!update_fail_htlcs.is_empty());
2338                         assert!(update_fulfill_htlcs.is_empty());
2339                         assert!(update_fail_malformed_htlcs.is_empty());
2340                         assert_eq!(nodes[1].node.get_our_node_id(), *node_id);
2341                 },
2342                 _ => panic!("Unexpected event"),
2343         };
2344         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
2345         check_closed_broadcast!(nodes[2]);
2346         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 1 (commitment tx)
2347         assert_eq!(node_txn.len(), 1);
2348         check_spends!(node_txn[0], chan_2.3.clone());
2349         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 71);
2350
2351         // Broadcast timeout transaction by B on received output from C's commitment tx on B's chain
2352         // Verify that B's ChannelManager is able to detect that HTLC is timeout by its own tx and react backward in consequence
2353         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2354         let timeout_tx;
2355         {
2356                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
2357                 assert_eq!(node_txn.len(), 8); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 6 (HTLC-Timeout tx, commitment tx, timeout tx) * 2 (block-rescan)
2358                 assert_eq!(node_txn[0], node_txn[5]);
2359                 assert_eq!(node_txn[1], node_txn[6]);
2360                 assert_eq!(node_txn[2], node_txn[7]);
2361                 check_spends!(node_txn[0], commitment_tx[0].clone());
2362                 assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2363                 check_spends!(node_txn[1], chan_2.3.clone());
2364                 check_spends!(node_txn[2], node_txn[1].clone());
2365                 assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2366                 assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2367                 check_spends!(node_txn[3], chan_2.3.clone());
2368                 check_spends!(node_txn[4], node_txn[3].clone());
2369                 assert_eq!(node_txn[3].input[0].witness.clone().last().unwrap().len(), 71);
2370                 assert_eq!(node_txn[4].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2371                 timeout_tx = node_txn[0].clone();
2372                 node_txn.clear();
2373         }
2374
2375         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![timeout_tx]}, 1);
2376         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2377         check_added_monitors!(nodes[1], 0);
2378         check_closed_broadcast!(nodes[1]);
2379
2380         expect_pending_htlcs_forwardable!(nodes[1]);
2381         check_added_monitors!(nodes[1], 1);
2382         let events = nodes[1].node.get_and_clear_pending_msg_events();
2383         assert_eq!(events.len(), 1);
2384         match events[0] {
2385                 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, .. } } => {
2386                         assert!(update_add_htlcs.is_empty());
2387                         assert!(!update_fail_htlcs.is_empty());
2388                         assert!(update_fulfill_htlcs.is_empty());
2389                         assert!(update_fail_malformed_htlcs.is_empty());
2390                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2391                 },
2392                 _ => panic!("Unexpected event"),
2393         };
2394         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
2395         assert_eq!(node_txn.len(), 0);
2396
2397         // Broadcast legit commitment tx from B on A's chain
2398         let commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
2399         check_spends!(commitment_tx[0], chan_1.3.clone());
2400
2401         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 200);
2402         check_closed_broadcast!(nodes[0]);
2403         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Timeout tx), ChannelMonitor : 2 (timeout tx) * 2 block-rescan
2404         assert_eq!(node_txn.len(), 4);
2405         assert_eq!(node_txn[0], node_txn[3]);
2406         check_spends!(node_txn[0], commitment_tx[0].clone());
2407         assert_eq!(node_txn[0].clone().input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
2408         check_spends!(node_txn[1], chan_1.3.clone());
2409         check_spends!(node_txn[2], node_txn[1].clone());
2410         assert_eq!(node_txn[1].clone().input[0].witness.last().unwrap().len(), 71);
2411         assert_eq!(node_txn[2].clone().input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
2412 }
2413
2414 #[test]
2415 fn test_simple_commitment_revoked_fail_backward() {
2416         // Test that in case of a revoked commitment tx, we detect the resolution of output by justice tx
2417         // and fail backward accordingly.
2418
2419         let nodes = create_network(3, &[None, None, None]);
2420
2421         // Create some initial channels
2422         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
2423         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
2424
2425         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2426         // Get the will-be-revoked local txn from nodes[2]
2427         let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2428         // Revoke the old state
2429         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, 3_000_000);
2430
2431         route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 3000000);
2432
2433         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2434         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2435         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2436         check_added_monitors!(nodes[1], 0);
2437         check_closed_broadcast!(nodes[1]);
2438
2439         expect_pending_htlcs_forwardable!(nodes[1]);
2440         check_added_monitors!(nodes[1], 1);
2441         let events = nodes[1].node.get_and_clear_pending_msg_events();
2442         assert_eq!(events.len(), 1);
2443         match events[0] {
2444                 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, .. } } => {
2445                         assert!(update_add_htlcs.is_empty());
2446                         assert_eq!(update_fail_htlcs.len(), 1);
2447                         assert!(update_fulfill_htlcs.is_empty());
2448                         assert!(update_fail_malformed_htlcs.is_empty());
2449                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2450
2451                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
2452                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2453
2454                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2455                         assert_eq!(events.len(), 1);
2456                         match events[0] {
2457                                 MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2458                                 _ => panic!("Unexpected event"),
2459                         }
2460                         let events = nodes[0].node.get_and_clear_pending_events();
2461                         assert_eq!(events.len(), 1);
2462                         match events[0] {
2463                                 Event::PaymentFailed { .. } => {},
2464                                 _ => panic!("Unexpected event"),
2465                         }
2466                 },
2467                 _ => panic!("Unexpected event"),
2468         }
2469 }
2470
2471 fn do_test_commitment_revoked_fail_backward_exhaustive(deliver_bs_raa: bool, use_dust: bool, no_to_remote: bool) {
2472         // Test that if our counterparty broadcasts a revoked commitment transaction we fail all
2473         // pending HTLCs on that channel backwards even if the HTLCs aren't present in our latest
2474         // commitment transaction anymore.
2475         // To do this, we have the peer which will broadcast a revoked commitment transaction send
2476         // a number of update_fail/commitment_signed updates without ever sending the RAA in
2477         // response to our commitment_signed. This is somewhat misbehavior-y, though not
2478         // technically disallowed and we should probably handle it reasonably.
2479         // Note that this is pretty exhaustive as an outbound HTLC which we haven't yet
2480         // failed/fulfilled backwards must be in at least one of the latest two remote commitment
2481         // transactions:
2482         // * Once we move it out of our holding cell/add it, we will immediately include it in a
2483         //   commitment_signed (implying it will be in the latest remote commitment transaction).
2484         // * Once they remove it, we will send a (the first) commitment_signed without the HTLC,
2485         //   and once they revoke the previous commitment transaction (allowing us to send a new
2486         //   commitment_signed) we will be free to fail/fulfill the HTLC backwards.
2487         let mut nodes = create_network(3, &[None, None, None]);
2488
2489         // Create some initial channels
2490         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
2491         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
2492
2493         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], if no_to_remote { 10_000 } else { 3_000_000 });
2494         // Get the will-be-revoked local txn from nodes[2]
2495         let revoked_local_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
2496         assert_eq!(revoked_local_txn[0].output.len(), if no_to_remote { 1 } else { 2 });
2497         // Revoke the old state
2498         claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage, if no_to_remote { 10_000 } else { 3_000_000});
2499
2500         let value = if use_dust {
2501                 // The dust limit applied to HTLC outputs considers the fee of the HTLC transaction as
2502                 // well, so HTLCs at exactly the dust limit will not be included in commitment txn.
2503                 nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().our_dust_limit_satoshis * 1000
2504         } else { 3000000 };
2505
2506         let (_, first_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2507         let (_, second_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2508         let (_, third_payment_hash) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], value);
2509
2510         assert!(nodes[2].node.fail_htlc_backwards(&first_payment_hash));
2511         expect_pending_htlcs_forwardable!(nodes[2]);
2512         check_added_monitors!(nodes[2], 1);
2513         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2514         assert!(updates.update_add_htlcs.is_empty());
2515         assert!(updates.update_fulfill_htlcs.is_empty());
2516         assert!(updates.update_fail_malformed_htlcs.is_empty());
2517         assert_eq!(updates.update_fail_htlcs.len(), 1);
2518         assert!(updates.update_fee.is_none());
2519         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
2520         let bs_raa = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
2521         // Drop the last RAA from 3 -> 2
2522
2523         assert!(nodes[2].node.fail_htlc_backwards(&second_payment_hash));
2524         expect_pending_htlcs_forwardable!(nodes[2]);
2525         check_added_monitors!(nodes[2], 1);
2526         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2527         assert!(updates.update_add_htlcs.is_empty());
2528         assert!(updates.update_fulfill_htlcs.is_empty());
2529         assert!(updates.update_fail_malformed_htlcs.is_empty());
2530         assert_eq!(updates.update_fail_htlcs.len(), 1);
2531         assert!(updates.update_fee.is_none());
2532         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
2533         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed).unwrap();
2534         check_added_monitors!(nodes[1], 1);
2535         // Note that nodes[1] is in AwaitingRAA, so won't send a CS
2536         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2537         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
2538         check_added_monitors!(nodes[2], 1);
2539
2540         assert!(nodes[2].node.fail_htlc_backwards(&third_payment_hash));
2541         expect_pending_htlcs_forwardable!(nodes[2]);
2542         check_added_monitors!(nodes[2], 1);
2543         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2544         assert!(updates.update_add_htlcs.is_empty());
2545         assert!(updates.update_fulfill_htlcs.is_empty());
2546         assert!(updates.update_fail_malformed_htlcs.is_empty());
2547         assert_eq!(updates.update_fail_htlcs.len(), 1);
2548         assert!(updates.update_fee.is_none());
2549         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
2550         // At this point first_payment_hash has dropped out of the latest two commitment
2551         // transactions that nodes[1] is tracking...
2552         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &updates.commitment_signed).unwrap();
2553         check_added_monitors!(nodes[1], 1);
2554         // Note that nodes[1] is (still) in AwaitingRAA, so won't send a CS
2555         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
2556         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
2557         check_added_monitors!(nodes[2], 1);
2558
2559         // Add a fourth HTLC, this one will get sequestered away in nodes[1]'s holding cell waiting
2560         // on nodes[2]'s RAA.
2561         let route = nodes[1].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
2562         let (_, fourth_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2563         nodes[1].node.send_payment(route, fourth_payment_hash).unwrap();
2564         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2565         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2566         check_added_monitors!(nodes[1], 0);
2567
2568         if deliver_bs_raa {
2569                 nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_raa).unwrap();
2570                 // One monitor for the new revocation preimage, no second on as we won't generate a new
2571                 // commitment transaction for nodes[0] until process_pending_htlc_forwards().
2572                 check_added_monitors!(nodes[1], 1);
2573                 let events = nodes[1].node.get_and_clear_pending_events();
2574                 assert_eq!(events.len(), 1);
2575                 match events[0] {
2576                         Event::PendingHTLCsForwardable { .. } => { },
2577                         _ => panic!("Unexpected event"),
2578                 };
2579                 // Deliberately don't process the pending fail-back so they all fail back at once after
2580                 // block connection just like the !deliver_bs_raa case
2581         }
2582
2583         let mut failed_htlcs = HashSet::new();
2584         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
2585
2586         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
2587         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
2588         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 1, true, header.bitcoin_hash());
2589
2590         let events = nodes[1].node.get_and_clear_pending_events();
2591         assert_eq!(events.len(), if deliver_bs_raa { 1 } else { 2 });
2592         match events[0] {
2593                 Event::PaymentFailed { ref payment_hash, .. } => {
2594                         assert_eq!(*payment_hash, fourth_payment_hash);
2595                 },
2596                 _ => panic!("Unexpected event"),
2597         }
2598         if !deliver_bs_raa {
2599                 match events[1] {
2600                         Event::PendingHTLCsForwardable { .. } => { },
2601                         _ => panic!("Unexpected event"),
2602                 };
2603         }
2604         nodes[1].node.process_pending_htlc_forwards();
2605         check_added_monitors!(nodes[1], 1);
2606
2607         let events = nodes[1].node.get_and_clear_pending_msg_events();
2608         assert_eq!(events.len(), if deliver_bs_raa { 3 } else { 2 });
2609         match events[if deliver_bs_raa { 1 } else { 0 }] {
2610                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { .. } } => {},
2611                 _ => panic!("Unexpected event"),
2612         }
2613         if deliver_bs_raa {
2614                 match events[0] {
2615                         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, .. } } => {
2616                                 assert_eq!(nodes[2].node.get_our_node_id(), *node_id);
2617                                 assert_eq!(update_add_htlcs.len(), 1);
2618                                 assert!(update_fulfill_htlcs.is_empty());
2619                                 assert!(update_fail_htlcs.is_empty());
2620                                 assert!(update_fail_malformed_htlcs.is_empty());
2621                         },
2622                         _ => panic!("Unexpected event"),
2623                 }
2624         }
2625         match events[if deliver_bs_raa { 2 } else { 1 }] {
2626                 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, .. } } => {
2627                         assert!(update_add_htlcs.is_empty());
2628                         assert_eq!(update_fail_htlcs.len(), 3);
2629                         assert!(update_fulfill_htlcs.is_empty());
2630                         assert!(update_fail_malformed_htlcs.is_empty());
2631                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
2632
2633                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[0]).unwrap();
2634                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[1]).unwrap();
2635                         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlcs[2]).unwrap();
2636
2637                         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
2638
2639                         let events = nodes[0].node.get_and_clear_pending_msg_events();
2640                         // If we delivered B's RAA we got an unknown preimage error, not something
2641                         // that we should update our routing table for.
2642                         assert_eq!(events.len(), if deliver_bs_raa { 2 } else { 3 });
2643                         for event in events {
2644                                 match event {
2645                                         MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
2646                                         _ => panic!("Unexpected event"),
2647                                 }
2648                         }
2649                         let events = nodes[0].node.get_and_clear_pending_events();
2650                         assert_eq!(events.len(), 3);
2651                         match events[0] {
2652                                 Event::PaymentFailed { ref payment_hash, .. } => {
2653                                         assert!(failed_htlcs.insert(payment_hash.0));
2654                                 },
2655                                 _ => panic!("Unexpected event"),
2656                         }
2657                         match events[1] {
2658                                 Event::PaymentFailed { ref payment_hash, .. } => {
2659                                         assert!(failed_htlcs.insert(payment_hash.0));
2660                                 },
2661                                 _ => panic!("Unexpected event"),
2662                         }
2663                         match events[2] {
2664                                 Event::PaymentFailed { ref payment_hash, .. } => {
2665                                         assert!(failed_htlcs.insert(payment_hash.0));
2666                                 },
2667                                 _ => panic!("Unexpected event"),
2668                         }
2669                 },
2670                 _ => panic!("Unexpected event"),
2671         }
2672
2673         assert!(failed_htlcs.contains(&first_payment_hash.0));
2674         assert!(failed_htlcs.contains(&second_payment_hash.0));
2675         assert!(failed_htlcs.contains(&third_payment_hash.0));
2676 }
2677
2678 #[test]
2679 fn test_commitment_revoked_fail_backward_exhaustive_a() {
2680         do_test_commitment_revoked_fail_backward_exhaustive(false, true, false);
2681         do_test_commitment_revoked_fail_backward_exhaustive(true, true, false);
2682         do_test_commitment_revoked_fail_backward_exhaustive(false, false, false);
2683         do_test_commitment_revoked_fail_backward_exhaustive(true, false, false);
2684 }
2685
2686 #[test]
2687 fn test_commitment_revoked_fail_backward_exhaustive_b() {
2688         do_test_commitment_revoked_fail_backward_exhaustive(false, true, true);
2689         do_test_commitment_revoked_fail_backward_exhaustive(true, true, true);
2690         do_test_commitment_revoked_fail_backward_exhaustive(false, false, true);
2691         do_test_commitment_revoked_fail_backward_exhaustive(true, false, true);
2692 }
2693
2694 #[test]
2695 fn test_htlc_ignore_latest_remote_commitment() {
2696         // Test that HTLC transactions spending the latest remote commitment transaction are simply
2697         // ignored if we cannot claim them. This originally tickled an invalid unwrap().
2698         let nodes = create_network(2, &[None, None]);
2699         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
2700
2701         route_payment(&nodes[0], &[&nodes[1]], 10000000);
2702         nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
2703         check_closed_broadcast!(nodes[0]);
2704
2705         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
2706         assert_eq!(node_txn.len(), 2);
2707
2708         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2709         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2710         check_closed_broadcast!(nodes[1]);
2711
2712         // Duplicate the block_connected call since this may happen due to other listeners
2713         // registering new transactions
2714         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone(), node_txn[1].clone()]}, 1);
2715 }
2716
2717 #[test]
2718 fn test_force_close_fail_back() {
2719         // Check which HTLCs are failed-backwards on channel force-closure
2720         let mut nodes = create_network(3, &[None, None, None]);
2721         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
2722         create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
2723
2724         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
2725
2726         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
2727
2728         let mut payment_event = {
2729                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
2730                 check_added_monitors!(nodes[0], 1);
2731
2732                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2733                 assert_eq!(events.len(), 1);
2734                 SendEvent::from_event(events.remove(0))
2735         };
2736
2737         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2738         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
2739
2740         expect_pending_htlcs_forwardable!(nodes[1]);
2741
2742         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
2743         assert_eq!(events_2.len(), 1);
2744         payment_event = SendEvent::from_event(events_2.remove(0));
2745         assert_eq!(payment_event.msgs.len(), 1);
2746
2747         check_added_monitors!(nodes[1], 1);
2748         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2749         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
2750         check_added_monitors!(nodes[2], 1);
2751         let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
2752
2753         // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
2754         // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
2755         // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
2756
2757         nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
2758         check_closed_broadcast!(nodes[2]);
2759         let tx = {
2760                 let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2761                 // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
2762                 // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
2763                 // back to nodes[1] upon timeout otherwise.
2764                 assert_eq!(node_txn.len(), 1);
2765                 node_txn.remove(0)
2766         };
2767
2768         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2769         nodes[1].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2770
2771         // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
2772         check_closed_broadcast!(nodes[1]);
2773
2774         // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
2775         {
2776                 let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
2777                 monitors.get_mut(&OutPoint::new(Sha256dHash::from_slice(&payment_event.commitment_msg.channel_id[..]).unwrap(), 0)).unwrap()
2778                         .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
2779         }
2780         nodes[2].block_notifier.block_connected_checked(&header, 1, &[&tx], &[1]);
2781         let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
2782         assert_eq!(node_txn.len(), 1);
2783         assert_eq!(node_txn[0].input.len(), 1);
2784         assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
2785         assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
2786         assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
2787
2788         check_spends!(node_txn[0], tx);
2789 }
2790
2791 #[test]
2792 fn test_unconf_chan() {
2793         // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
2794         let nodes = create_network(2, &[None, None]);
2795         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
2796
2797         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2798         assert_eq!(channel_state.by_id.len(), 1);
2799         assert_eq!(channel_state.short_to_id.len(), 1);
2800         mem::drop(channel_state);
2801
2802         let mut headers = Vec::new();
2803         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2804         headers.push(header.clone());
2805         for _i in 2..100 {
2806                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2807                 headers.push(header.clone());
2808         }
2809         let mut height = 99;
2810         while !headers.is_empty() {
2811                 nodes[0].node.block_disconnected(&headers.pop().unwrap(), height);
2812                 height -= 1;
2813         }
2814         check_closed_broadcast!(nodes[0]);
2815         let channel_state = nodes[0].node.channel_state.lock().unwrap();
2816         assert_eq!(channel_state.by_id.len(), 0);
2817         assert_eq!(channel_state.short_to_id.len(), 0);
2818 }
2819
2820 #[test]
2821 fn test_simple_peer_disconnect() {
2822         // Test that we can reconnect when there are no lost messages
2823         let nodes = create_network(3, &[None, None, None]);
2824         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
2825         create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
2826
2827         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2828         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2829         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2830
2831         let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2832         let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2833         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
2834         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1, 1_000_000);
2835
2836         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2837         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2838         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2839
2840         let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2841         let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
2842         let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2843         let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
2844
2845         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2846         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2847
2848         claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3, 1_000_000);
2849         fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
2850
2851         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
2852         {
2853                 let events = nodes[0].node.get_and_clear_pending_events();
2854                 assert_eq!(events.len(), 2);
2855                 match events[0] {
2856                         Event::PaymentSent { payment_preimage } => {
2857                                 assert_eq!(payment_preimage, payment_preimage_3);
2858                         },
2859                         _ => panic!("Unexpected event"),
2860                 }
2861                 match events[1] {
2862                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
2863                                 assert_eq!(payment_hash, payment_hash_5);
2864                                 assert!(rejected_by_dest);
2865                         },
2866                         _ => panic!("Unexpected event"),
2867                 }
2868         }
2869
2870         claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4, 1_000_000);
2871         fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
2872 }
2873
2874 fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
2875         // Test that we can reconnect when in-flight HTLC updates get dropped
2876         let mut nodes = create_network(2, &[None, None]);
2877         if messages_delivered == 0 {
2878                 create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001, LocalFeatures::new(), LocalFeatures::new());
2879                 // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
2880         } else {
2881                 create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
2882         }
2883
2884         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();
2885         let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
2886
2887         let payment_event = {
2888                 nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
2889                 check_added_monitors!(nodes[0], 1);
2890
2891                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
2892                 assert_eq!(events.len(), 1);
2893                 SendEvent::from_event(events.remove(0))
2894         };
2895         assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
2896
2897         if messages_delivered < 2 {
2898                 // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
2899         } else {
2900                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2901                 if messages_delivered >= 3 {
2902                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
2903                         check_added_monitors!(nodes[1], 1);
2904                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
2905
2906                         if messages_delivered >= 4 {
2907                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
2908                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
2909                                 check_added_monitors!(nodes[0], 1);
2910
2911                                 if messages_delivered >= 5 {
2912                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
2913                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
2914                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
2915                                         check_added_monitors!(nodes[0], 1);
2916
2917                                         if messages_delivered >= 6 {
2918                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
2919                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
2920                                                 check_added_monitors!(nodes[1], 1);
2921                                         }
2922                                 }
2923                         }
2924                 }
2925         }
2926
2927         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2928         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2929         if messages_delivered < 3 {
2930                 // Even if the funding_locked messages get exchanged, as long as nothing further was
2931                 // received on either side, both sides will need to resend them.
2932                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
2933         } else if messages_delivered == 3 {
2934                 // nodes[0] still wants its RAA + commitment_signed
2935                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
2936         } else if messages_delivered == 4 {
2937                 // nodes[0] still wants its commitment_signed
2938                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
2939         } else if messages_delivered == 5 {
2940                 // nodes[1] still wants its final RAA
2941                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
2942         } else if messages_delivered == 6 {
2943                 // Everything was delivered...
2944                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2945         }
2946
2947         let events_1 = nodes[1].node.get_and_clear_pending_events();
2948         assert_eq!(events_1.len(), 1);
2949         match events_1[0] {
2950                 Event::PendingHTLCsForwardable { .. } => { },
2951                 _ => panic!("Unexpected event"),
2952         };
2953
2954         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
2955         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
2956         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
2957
2958         nodes[1].node.process_pending_htlc_forwards();
2959
2960         let events_2 = nodes[1].node.get_and_clear_pending_events();
2961         assert_eq!(events_2.len(), 1);
2962         match events_2[0] {
2963                 Event::PaymentReceived { ref payment_hash, amt } => {
2964                         assert_eq!(payment_hash_1, *payment_hash);
2965                         assert_eq!(amt, 1000000);
2966                 },
2967                 _ => panic!("Unexpected event"),
2968         }
2969
2970         nodes[1].node.claim_funds(payment_preimage_1, 1_000_000);
2971         check_added_monitors!(nodes[1], 1);
2972
2973         let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
2974         assert_eq!(events_3.len(), 1);
2975         let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
2976                 MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2977                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
2978                         assert!(updates.update_add_htlcs.is_empty());
2979                         assert!(updates.update_fail_htlcs.is_empty());
2980                         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
2981                         assert!(updates.update_fail_malformed_htlcs.is_empty());
2982                         assert!(updates.update_fee.is_none());
2983                         (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
2984                 },
2985                 _ => panic!("Unexpected event"),
2986         };
2987
2988         if messages_delivered >= 1 {
2989                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
2990
2991                 let events_4 = nodes[0].node.get_and_clear_pending_events();
2992                 assert_eq!(events_4.len(), 1);
2993                 match events_4[0] {
2994                         Event::PaymentSent { ref payment_preimage } => {
2995                                 assert_eq!(payment_preimage_1, *payment_preimage);
2996                         },
2997                         _ => panic!("Unexpected event"),
2998                 }
2999
3000                 if messages_delivered >= 2 {
3001                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
3002                         check_added_monitors!(nodes[0], 1);
3003                         let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3004
3005                         if messages_delivered >= 3 {
3006                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3007                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3008                                 check_added_monitors!(nodes[1], 1);
3009
3010                                 if messages_delivered >= 4 {
3011                                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
3012                                         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3013                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3014                                         check_added_monitors!(nodes[1], 1);
3015
3016                                         if messages_delivered >= 5 {
3017                                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3018                                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3019                                                 check_added_monitors!(nodes[0], 1);
3020                                         }
3021                                 }
3022                         }
3023                 }
3024         }
3025
3026         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3027         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3028         if messages_delivered < 2 {
3029                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
3030                 //TODO: Deduplicate PaymentSent events, then enable this if:
3031                 //if messages_delivered < 1 {
3032                         let events_4 = nodes[0].node.get_and_clear_pending_events();
3033                         assert_eq!(events_4.len(), 1);
3034                         match events_4[0] {
3035                                 Event::PaymentSent { ref payment_preimage } => {
3036                                         assert_eq!(payment_preimage_1, *payment_preimage);
3037                                 },
3038                                 _ => panic!("Unexpected event"),
3039                         }
3040                 //}
3041         } else if messages_delivered == 2 {
3042                 // nodes[0] still wants its RAA + commitment_signed
3043                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
3044         } else if messages_delivered == 3 {
3045                 // nodes[0] still wants its commitment_signed
3046                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
3047         } else if messages_delivered == 4 {
3048                 // nodes[1] still wants its final RAA
3049                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
3050         } else if messages_delivered == 5 {
3051                 // Everything was delivered...
3052                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3053         }
3054
3055         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3056         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3057         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3058
3059         // Channel should still work fine...
3060         let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
3061         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3062 }
3063
3064 #[test]
3065 fn test_drop_messages_peer_disconnect_a() {
3066         do_test_drop_messages_peer_disconnect(0);
3067         do_test_drop_messages_peer_disconnect(1);
3068         do_test_drop_messages_peer_disconnect(2);
3069         do_test_drop_messages_peer_disconnect(3);
3070 }
3071
3072 #[test]
3073 fn test_drop_messages_peer_disconnect_b() {
3074         do_test_drop_messages_peer_disconnect(4);
3075         do_test_drop_messages_peer_disconnect(5);
3076         do_test_drop_messages_peer_disconnect(6);
3077 }
3078
3079 #[test]
3080 fn test_funding_peer_disconnect() {
3081         // Test that we can lock in our funding tx while disconnected
3082         let nodes = create_network(2, &[None, None]);
3083         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, LocalFeatures::new(), LocalFeatures::new());
3084
3085         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3086         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3087
3088         confirm_transaction(&nodes[0].block_notifier, &nodes[0].chain_monitor, &tx, tx.version);
3089         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3090         assert_eq!(events_1.len(), 1);
3091         match events_1[0] {
3092                 MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
3093                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3094                 },
3095                 _ => panic!("Unexpected event"),
3096         }
3097
3098         reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3099
3100         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3101         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3102
3103         confirm_transaction(&nodes[1].block_notifier, &nodes[1].chain_monitor, &tx, tx.version);
3104         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3105         assert_eq!(events_2.len(), 2);
3106         let funding_locked = match events_2[0] {
3107                 MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3108                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3109                         msg.clone()
3110                 },
3111                 _ => panic!("Unexpected event"),
3112         };
3113         let bs_announcement_sigs = match events_2[1] {
3114                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3115                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3116                         msg.clone()
3117                 },
3118                 _ => panic!("Unexpected event"),
3119         };
3120
3121         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3122
3123         nodes[0].node.handle_funding_locked(&nodes[1].node.get_our_node_id(), &funding_locked).unwrap();
3124         nodes[0].node.handle_announcement_signatures(&nodes[1].node.get_our_node_id(), &bs_announcement_sigs).unwrap();
3125         let events_3 = nodes[0].node.get_and_clear_pending_msg_events();
3126         assert_eq!(events_3.len(), 2);
3127         let as_announcement_sigs = match events_3[0] {
3128                 MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3129                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
3130                         msg.clone()
3131                 },
3132                 _ => panic!("Unexpected event"),
3133         };
3134         let (as_announcement, as_update) = match events_3[1] {
3135                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3136                         (msg.clone(), update_msg.clone())
3137                 },
3138                 _ => panic!("Unexpected event"),
3139         };
3140
3141         nodes[1].node.handle_announcement_signatures(&nodes[0].node.get_our_node_id(), &as_announcement_sigs).unwrap();
3142         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
3143         assert_eq!(events_4.len(), 1);
3144         let (_, bs_update) = match events_4[0] {
3145                 MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3146                         (msg.clone(), update_msg.clone())
3147                 },
3148                 _ => panic!("Unexpected event"),
3149         };
3150
3151         nodes[0].router.handle_channel_announcement(&as_announcement).unwrap();
3152         nodes[0].router.handle_channel_update(&bs_update).unwrap();
3153         nodes[0].router.handle_channel_update(&as_update).unwrap();
3154
3155         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3156         let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
3157         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage, 1_000_000);
3158 }
3159
3160 #[test]
3161 fn test_drop_messages_peer_disconnect_dual_htlc() {
3162         // Test that we can handle reconnecting when both sides of a channel have pending
3163         // commitment_updates when we disconnect.
3164         let mut nodes = create_network(2, &[None, None]);
3165         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
3166
3167         let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3168
3169         // Now try to send a second payment which will fail to send
3170         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
3171         let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
3172
3173         nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
3174         check_added_monitors!(nodes[0], 1);
3175
3176         let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
3177         assert_eq!(events_1.len(), 1);
3178         match events_1[0] {
3179                 MessageSendEvent::UpdateHTLCs { .. } => {},
3180                 _ => panic!("Unexpected event"),
3181         }
3182
3183         assert!(nodes[1].node.claim_funds(payment_preimage_1, 1_000_000));
3184         check_added_monitors!(nodes[1], 1);
3185
3186         let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
3187         assert_eq!(events_2.len(), 1);
3188         match events_2[0] {
3189                 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 } } => {
3190                         assert_eq!(*node_id, nodes[0].node.get_our_node_id());
3191                         assert!(update_add_htlcs.is_empty());
3192                         assert_eq!(update_fulfill_htlcs.len(), 1);
3193                         assert!(update_fail_htlcs.is_empty());
3194                         assert!(update_fail_malformed_htlcs.is_empty());
3195                         assert!(update_fee.is_none());
3196
3197                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
3198                         let events_3 = nodes[0].node.get_and_clear_pending_events();
3199                         assert_eq!(events_3.len(), 1);
3200                         match events_3[0] {
3201                                 Event::PaymentSent { ref payment_preimage } => {
3202                                         assert_eq!(*payment_preimage, payment_preimage_1);
3203                                 },
3204                                 _ => panic!("Unexpected event"),
3205                         }
3206
3207                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
3208                         let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3209                         // No commitment_signed so get_event_msg's assert(len == 1) passes
3210                         check_added_monitors!(nodes[0], 1);
3211                 },
3212                 _ => panic!("Unexpected event"),
3213         }
3214
3215         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
3216         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3217
3218         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
3219         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3220         assert_eq!(reestablish_1.len(), 1);
3221         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
3222         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3223         assert_eq!(reestablish_2.len(), 1);
3224
3225         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
3226         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
3227         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
3228         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
3229
3230         assert!(as_resp.0.is_none());
3231         assert!(bs_resp.0.is_none());
3232
3233         assert!(bs_resp.1.is_none());
3234         assert!(bs_resp.2.is_none());
3235
3236         assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
3237
3238         assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
3239         assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
3240         assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
3241         assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
3242         assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
3243         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]).unwrap();
3244         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
3245         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3246         // No commitment_signed so get_event_msg's assert(len == 1) passes
3247         check_added_monitors!(nodes[1], 1);
3248
3249         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
3250         let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3251         assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
3252         assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
3253         assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
3254         assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
3255         assert!(bs_second_commitment_signed.update_fee.is_none());
3256         check_added_monitors!(nodes[1], 1);
3257
3258         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3259         let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3260         assert!(as_commitment_signed.update_add_htlcs.is_empty());
3261         assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
3262         assert!(as_commitment_signed.update_fail_htlcs.is_empty());
3263         assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
3264         assert!(as_commitment_signed.update_fee.is_none());
3265         check_added_monitors!(nodes[0], 1);
3266
3267         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
3268         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3269         // No commitment_signed so get_event_msg's assert(len == 1) passes
3270         check_added_monitors!(nodes[0], 1);
3271
3272         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
3273         let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3274         // No commitment_signed so get_event_msg's assert(len == 1) passes
3275         check_added_monitors!(nodes[1], 1);
3276
3277         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3278         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3279         check_added_monitors!(nodes[1], 1);
3280
3281         expect_pending_htlcs_forwardable!(nodes[1]);
3282
3283         let events_5 = nodes[1].node.get_and_clear_pending_events();
3284         assert_eq!(events_5.len(), 1);
3285         match events_5[0] {
3286                 Event::PaymentReceived { ref payment_hash, amt: _ } => {
3287                         assert_eq!(payment_hash_2, *payment_hash);
3288                 },
3289                 _ => panic!("Unexpected event"),
3290         }
3291
3292         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
3293         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3294         check_added_monitors!(nodes[0], 1);
3295
3296         claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2, 1_000_000);
3297 }
3298
3299 #[test]
3300 fn test_invalid_channel_announcement() {
3301         //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
3302         let secp_ctx = Secp256k1::new();
3303         let nodes = create_network(2, &[None, None]);
3304
3305         let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1], LocalFeatures::new(), LocalFeatures::new());
3306
3307         let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
3308         let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
3309         let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3310         let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
3311
3312         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 } );
3313
3314         let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
3315         let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
3316
3317         let as_network_key = nodes[0].node.get_our_node_id();
3318         let bs_network_key = nodes[1].node.get_our_node_id();
3319
3320         let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
3321
3322         let mut chan_announcement;
3323
3324         macro_rules! dummy_unsigned_msg {
3325                 () => {
3326                         msgs::UnsignedChannelAnnouncement {
3327                                 features: msgs::GlobalFeatures::new(),
3328                                 chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
3329                                 short_channel_id: as_chan.get_short_channel_id().unwrap(),
3330                                 node_id_1: if were_node_one { as_network_key } else { bs_network_key },
3331                                 node_id_2: if were_node_one { bs_network_key } else { as_network_key },
3332                                 bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
3333                                 bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
3334                                 excess_data: Vec::new(),
3335                         };
3336                 }
3337         }
3338
3339         macro_rules! sign_msg {
3340                 ($unsigned_msg: expr) => {
3341                         let msghash = Message::from_slice(&Sha256dHash::hash(&$unsigned_msg.encode()[..])[..]).unwrap();
3342                         let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
3343                         let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
3344                         let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].keys_manager.get_node_secret());
3345                         let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].keys_manager.get_node_secret());
3346                         chan_announcement = msgs::ChannelAnnouncement {
3347                                 node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
3348                                 node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
3349                                 bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
3350                                 bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
3351                                 contents: $unsigned_msg
3352                         }
3353                 }
3354         }
3355
3356         let unsigned_msg = dummy_unsigned_msg!();
3357         sign_msg!(unsigned_msg);
3358         assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
3359         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 } );
3360
3361         // Configured with Network::Testnet
3362         let mut unsigned_msg = dummy_unsigned_msg!();
3363         unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
3364         sign_msg!(unsigned_msg);
3365         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3366
3367         let mut unsigned_msg = dummy_unsigned_msg!();
3368         unsigned_msg.chain_hash = Sha256dHash::hash(&[1,2,3,4,5,6,7,8,9]);
3369         sign_msg!(unsigned_msg);
3370         assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
3371 }
3372
3373 #[test]
3374 fn test_no_txn_manager_serialize_deserialize() {
3375         let mut nodes = create_network(2, &[None, None]);
3376
3377         let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001, LocalFeatures::new(), LocalFeatures::new());
3378
3379         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3380
3381         let nodes_0_serialized = nodes[0].node.encode();
3382         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3383         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3384
3385         nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 })));
3386         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3387         let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3388         assert!(chan_0_monitor_read.is_empty());
3389
3390         let mut nodes_0_read = &nodes_0_serialized[..];
3391         let config = UserConfig::new();
3392         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3393         let (_, nodes_0_deserialized) = {
3394                 let mut channel_monitors = HashMap::new();
3395                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
3396                 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3397                         default_config: config,
3398                         keys_manager,
3399                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3400                         monitor: nodes[0].chan_monitor.clone(),
3401                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3402                         logger: Arc::new(test_utils::TestLogger::new()),
3403                         channel_monitors: &channel_monitors,
3404                 }).unwrap()
3405         };
3406         assert!(nodes_0_read.is_empty());
3407
3408         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3409         nodes[0].node = Arc::new(nodes_0_deserialized);
3410         let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
3411         nodes[0].block_notifier.register_listener(Arc::downgrade(&nodes_0_as_listener));
3412         assert_eq!(nodes[0].node.list_channels().len(), 1);
3413         check_added_monitors!(nodes[0], 1);
3414
3415         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
3416         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
3417         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
3418         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
3419
3420         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
3421         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3422         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
3423         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3424
3425         let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
3426         let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
3427         for node in nodes.iter() {
3428                 assert!(node.router.handle_channel_announcement(&announcement).unwrap());
3429                 node.router.handle_channel_update(&as_update).unwrap();
3430                 node.router.handle_channel_update(&bs_update).unwrap();
3431         }
3432
3433         send_payment(&nodes[0], &[&nodes[1]], 1000000, 1_000_000);
3434 }
3435
3436 #[test]
3437 fn test_simple_manager_serialize_deserialize() {
3438         let mut nodes = create_network(2, &[None, None]);
3439         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
3440
3441         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3442         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
3443
3444         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3445
3446         let nodes_0_serialized = nodes[0].node.encode();
3447         let mut chan_0_monitor_serialized = test_utils::TestVecWriter(Vec::new());
3448         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
3449
3450         nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 })));
3451         let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
3452         let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
3453         assert!(chan_0_monitor_read.is_empty());
3454
3455         let mut nodes_0_read = &nodes_0_serialized[..];
3456         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3457         let (_, nodes_0_deserialized) = {
3458                 let mut channel_monitors = HashMap::new();
3459                 channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
3460                 <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3461                         default_config: UserConfig::new(),
3462                         keys_manager,
3463                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3464                         monitor: nodes[0].chan_monitor.clone(),
3465                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3466                         logger: Arc::new(test_utils::TestLogger::new()),
3467                         channel_monitors: &channel_monitors,
3468                 }).unwrap()
3469         };
3470         assert!(nodes_0_read.is_empty());
3471
3472         assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
3473         nodes[0].node = Arc::new(nodes_0_deserialized);
3474         check_added_monitors!(nodes[0], 1);
3475
3476         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3477
3478         fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
3479         claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage, 1_000_000);
3480 }
3481
3482 #[test]
3483 fn test_manager_serialize_deserialize_inconsistent_monitor() {
3484         // Test deserializing a ChannelManager with an out-of-date ChannelMonitor
3485         let mut nodes = create_network(4, &[None, None, None, None]);
3486         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
3487         create_announced_chan_between_nodes(&nodes, 2, 0, LocalFeatures::new(), LocalFeatures::new());
3488         let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3, LocalFeatures::new(), LocalFeatures::new());
3489
3490         let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
3491
3492         // Serialize the ChannelManager here, but the monitor we keep up-to-date
3493         let nodes_0_serialized = nodes[0].node.encode();
3494
3495         route_payment(&nodes[0], &[&nodes[3]], 1000000);
3496         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3497         nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3498         nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
3499
3500         // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
3501         // nodes[3])
3502         let mut node_0_monitors_serialized = Vec::new();
3503         for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
3504                 let mut writer = test_utils::TestVecWriter(Vec::new());
3505                 monitor.1.write_for_disk(&mut writer).unwrap();
3506                 node_0_monitors_serialized.push(writer.0);
3507         }
3508
3509         nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new()), Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 })));
3510         let mut node_0_monitors = Vec::new();
3511         for serialized in node_0_monitors_serialized.iter() {
3512                 let mut read = &serialized[..];
3513                 let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
3514                 assert!(read.is_empty());
3515                 node_0_monitors.push(monitor);
3516         }
3517
3518         let mut nodes_0_read = &nodes_0_serialized[..];
3519         let keys_manager = Arc::new(test_utils::TestKeysInterface::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
3520         let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
3521                 default_config: UserConfig::new(),
3522                 keys_manager,
3523                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
3524                 monitor: nodes[0].chan_monitor.clone(),
3525                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
3526                 logger: Arc::new(test_utils::TestLogger::new()),
3527                 channel_monitors: &node_0_monitors.iter().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
3528         }).unwrap();
3529         assert!(nodes_0_read.is_empty());
3530
3531         { // Channel close should result in a commitment tx and an HTLC tx
3532                 let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3533                 assert_eq!(txn.len(), 2);
3534                 assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
3535                 assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
3536         }
3537
3538         for monitor in node_0_monitors.drain(..) {
3539                 assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
3540                 check_added_monitors!(nodes[0], 1);
3541         }
3542         nodes[0].node = Arc::new(nodes_0_deserialized);
3543
3544         // nodes[1] and nodes[2] have no lost state with nodes[0]...
3545         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3546         reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
3547         //... and we can even still claim the payment!
3548         claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage, 1_000_000);
3549
3550         nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
3551         let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
3552         nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
3553         if let Err(msgs::LightningError { action: msgs::ErrorAction::SendErrorMessage { msg }, .. }) = nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish) {
3554                 assert_eq!(msg.channel_id, channel_id);
3555         } else { panic!("Unexpected result"); }
3556 }
3557
3558 macro_rules! check_spendable_outputs {
3559         ($node: expr, $der_idx: expr) => {
3560                 {
3561                         let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
3562                         let mut txn = Vec::new();
3563                         for event in events {
3564                                 match event {
3565                                         Event::SpendableOutputs { ref outputs } => {
3566                                                 for outp in outputs {
3567                                                         match *outp {
3568                                                                 SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
3569                                                                         let input = TxIn {
3570                                                                                 previous_output: outpoint.clone(),
3571                                                                                 script_sig: Script::new(),
3572                                                                                 sequence: 0,
3573                                                                                 witness: Vec::new(),
3574                                                                         };
3575                                                                         let outp = TxOut {
3576                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3577                                                                                 value: output.value,
3578                                                                         };
3579                                                                         let mut spend_tx = Transaction {
3580                                                                                 version: 2,
3581                                                                                 lock_time: 0,
3582                                                                                 input: vec![input],
3583                                                                                 output: vec![outp],
3584                                                                         };
3585                                                                         let secp_ctx = Secp256k1::new();
3586                                                                         let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
3587                                                                         let witness_script = Address::p2pkh(&::bitcoin::PublicKey{compressed: true, key: remotepubkey}, Network::Testnet).script_pubkey();
3588                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3589                                                                         let remotesig = secp_ctx.sign(&sighash, key);
3590                                                                         spend_tx.input[0].witness.push(remotesig.serialize_der().to_vec());
3591                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3592                                                                         spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
3593                                                                         txn.push(spend_tx);
3594                                                                 },
3595                                                                 SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
3596                                                                         let input = TxIn {
3597                                                                                 previous_output: outpoint.clone(),
3598                                                                                 script_sig: Script::new(),
3599                                                                                 sequence: *to_self_delay as u32,
3600                                                                                 witness: Vec::new(),
3601                                                                         };
3602                                                                         let outp = TxOut {
3603                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3604                                                                                 value: output.value,
3605                                                                         };
3606                                                                         let mut spend_tx = Transaction {
3607                                                                                 version: 2,
3608                                                                                 lock_time: 0,
3609                                                                                 input: vec![input],
3610                                                                                 output: vec![outp],
3611                                                                         };
3612                                                                         let secp_ctx = Secp256k1::new();
3613                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
3614                                                                         let local_delaysig = secp_ctx.sign(&sighash, key);
3615                                                                         spend_tx.input[0].witness.push(local_delaysig.serialize_der().to_vec());
3616                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3617                                                                         spend_tx.input[0].witness.push(vec!(0));
3618                                                                         spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
3619                                                                         txn.push(spend_tx);
3620                                                                 },
3621                                                                 SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
3622                                                                         let secp_ctx = Secp256k1::new();
3623                                                                         let input = TxIn {
3624                                                                                 previous_output: outpoint.clone(),
3625                                                                                 script_sig: Script::new(),
3626                                                                                 sequence: 0,
3627                                                                                 witness: Vec::new(),
3628                                                                         };
3629                                                                         let outp = TxOut {
3630                                                                                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
3631                                                                                 value: output.value,
3632                                                                         };
3633                                                                         let mut spend_tx = Transaction {
3634                                                                                 version: 2,
3635                                                                                 lock_time: 0,
3636                                                                                 input: vec![input],
3637                                                                                 output: vec![outp.clone()],
3638                                                                         };
3639                                                                         let secret = {
3640                                                                                 match ExtendedPrivKey::new_master(Network::Testnet, &$node.node_seed) {
3641                                                                                         Ok(master_key) => {
3642                                                                                                 match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx).expect("key space exhausted")) {
3643                                                                                                         Ok(key) => key,
3644                                                                                                         Err(_) => panic!("Your RNG is busted"),
3645                                                                                                 }
3646                                                                                         }
3647                                                                                         Err(_) => panic!("Your rng is busted"),
3648                                                                                 }
3649                                                                         };
3650                                                                         let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
3651                                                                         let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
3652                                                                         let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
3653                                                                         let sig = secp_ctx.sign(&sighash, &secret.private_key.key);
3654                                                                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
3655                                                                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
3656                                                                         spend_tx.input[0].witness.push(pubkey.key.serialize().to_vec());
3657                                                                         txn.push(spend_tx);
3658                                                                 },
3659                                                         }
3660                                                 }
3661                                         },
3662                                         _ => panic!("Unexpected event"),
3663                                 };
3664                         }
3665                         txn
3666                 }
3667         }
3668 }
3669
3670 #[test]
3671 fn test_claim_sizeable_push_msat() {
3672         // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
3673         let nodes = create_network(2, &[None, None]);
3674
3675         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, LocalFeatures::new(), LocalFeatures::new());
3676         nodes[1].node.force_close_channel(&chan.2);
3677         check_closed_broadcast!(nodes[1]);
3678         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3679         assert_eq!(node_txn.len(), 1);
3680         check_spends!(node_txn[0], chan.3.clone());
3681         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
3682
3683         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3684         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3685         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3686         assert_eq!(spend_txn.len(), 1);
3687         check_spends!(spend_txn[0], node_txn[0].clone());
3688 }
3689
3690 #[test]
3691 fn test_claim_on_remote_sizeable_push_msat() {
3692         // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3693         // to_remote output is encumbered by a P2WPKH
3694         let nodes = create_network(2, &[None, None]);
3695
3696         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000, LocalFeatures::new(), LocalFeatures::new());
3697         nodes[0].node.force_close_channel(&chan.2);
3698         check_closed_broadcast!(nodes[0]);
3699
3700         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3701         assert_eq!(node_txn.len(), 1);
3702         check_spends!(node_txn[0], chan.3.clone());
3703         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
3704
3705         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3706         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
3707         check_closed_broadcast!(nodes[1]);
3708         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3709         assert_eq!(spend_txn.len(), 2);
3710         assert_eq!(spend_txn[0], spend_txn[1]);
3711         check_spends!(spend_txn[0], node_txn[0].clone());
3712 }
3713
3714 #[test]
3715 fn test_claim_on_remote_revoked_sizeable_push_msat() {
3716         // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
3717         // to_remote output is encumbered by a P2WPKH
3718
3719         let nodes = create_network(2, &[None, None]);
3720
3721         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000, LocalFeatures::new(), LocalFeatures::new());
3722         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3723         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
3724         assert_eq!(revoked_local_txn[0].input.len(), 1);
3725         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
3726
3727         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3728         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3729         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3730         check_closed_broadcast!(nodes[1]);
3731
3732         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3733         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3734         assert_eq!(spend_txn.len(), 4);
3735         assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
3736         check_spends!(spend_txn[0], revoked_local_txn[0].clone());
3737         assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
3738         check_spends!(spend_txn[1], node_txn[0].clone());
3739 }
3740
3741 #[test]
3742 fn test_static_spendable_outputs_preimage_tx() {
3743         let nodes = create_network(2, &[None, None]);
3744
3745         // Create some initial channels
3746         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
3747
3748         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3749
3750         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3751         assert_eq!(commitment_tx[0].input.len(), 1);
3752         assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
3753
3754         // Settle A's commitment tx on B's chain
3755         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3756         assert!(nodes[1].node.claim_funds(payment_preimage, 3_000_000));
3757         check_added_monitors!(nodes[1], 1);
3758         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
3759         let events = nodes[1].node.get_and_clear_pending_msg_events();
3760         match events[0] {
3761                 MessageSendEvent::UpdateHTLCs { .. } => {},
3762                 _ => panic!("Unexpected event"),
3763         }
3764         match events[1] {
3765                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
3766                 _ => panic!("Unexepected event"),
3767         }
3768
3769         // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
3770         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 1 (local commitment tx), ChannelMonitor: 2 (1 preimage tx) * 2 (block-rescan)
3771         check_spends!(node_txn[0], commitment_tx[0].clone());
3772         assert_eq!(node_txn[0], node_txn[2]);
3773         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3774         check_spends!(node_txn[1], chan_1.3.clone());
3775
3776         let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
3777         assert_eq!(spend_txn.len(), 2);
3778         assert_eq!(spend_txn[0], spend_txn[1]);
3779         check_spends!(spend_txn[0], node_txn[0].clone());
3780 }
3781
3782 #[test]
3783 fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
3784         let nodes = create_network(2, &[None, None]);
3785
3786         // Create some initial channels
3787         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
3788
3789         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3790         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
3791         assert_eq!(revoked_local_txn[0].input.len(), 1);
3792         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3793
3794         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3795
3796         let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3797         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3798         check_closed_broadcast!(nodes[1]);
3799
3800         let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3801         assert_eq!(node_txn.len(), 3);
3802         assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
3803         assert_eq!(node_txn[0].input.len(), 2);
3804         check_spends!(node_txn[0], revoked_local_txn[0].clone());
3805
3806         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3807         assert_eq!(spend_txn.len(), 2);
3808         assert_eq!(spend_txn[0], spend_txn[1]);
3809         check_spends!(spend_txn[0], node_txn[0].clone());
3810 }
3811
3812 #[test]
3813 fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
3814         let nodes = create_network(2, &[None, None]);
3815
3816         // Create some initial channels
3817         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
3818
3819         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3820         let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3821         assert_eq!(revoked_local_txn[0].input.len(), 1);
3822         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3823
3824         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3825
3826         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3827         // A will generate HTLC-Timeout from revoked commitment tx
3828         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3829         check_closed_broadcast!(nodes[0]);
3830
3831         let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3832         assert_eq!(revoked_htlc_txn.len(), 3);
3833         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3834         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3835         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3836         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3837         check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
3838
3839         // B will generate justice tx from A's revoked commitment/HTLC tx
3840         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3841         check_closed_broadcast!(nodes[1]);
3842
3843         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3844         assert_eq!(node_txn.len(), 4);
3845         assert_eq!(node_txn[3].input.len(), 1);
3846         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3847
3848         // Check B's ChannelMonitor was able to generate the right spendable output descriptor
3849         let spend_txn = check_spendable_outputs!(nodes[1], 1);
3850         assert_eq!(spend_txn.len(), 3);
3851         assert_eq!(spend_txn[0], spend_txn[1]);
3852         check_spends!(spend_txn[0], node_txn[0].clone());
3853         check_spends!(spend_txn[2], node_txn[3].clone());
3854 }
3855
3856 #[test]
3857 fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
3858         let nodes = create_network(2, &[None, None]);
3859
3860         // Create some initial channels
3861         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
3862
3863         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3864         let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3865         assert_eq!(revoked_local_txn[0].input.len(), 1);
3866         assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
3867
3868         claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage, 3_000_000);
3869
3870         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3871         // B will generate HTLC-Success from revoked commitment tx
3872         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3873         check_closed_broadcast!(nodes[1]);
3874         let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3875
3876         assert_eq!(revoked_htlc_txn.len(), 3);
3877         assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
3878         assert_eq!(revoked_htlc_txn[0].input.len(), 1);
3879         assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3880         check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
3881
3882         // A will generate justice tx from B's revoked commitment/HTLC tx
3883         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
3884         check_closed_broadcast!(nodes[0]);
3885
3886         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
3887         assert_eq!(node_txn.len(), 4);
3888         assert_eq!(node_txn[3].input.len(), 1);
3889         check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
3890
3891         // Check A's ChannelMonitor was able to generate the right spendable output descriptor
3892         let spend_txn = check_spendable_outputs!(nodes[0], 1);
3893         assert_eq!(spend_txn.len(), 5);
3894         assert_eq!(spend_txn[0], spend_txn[2]);
3895         assert_eq!(spend_txn[1], spend_txn[3]);
3896         check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
3897         check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
3898         check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
3899 }
3900
3901 #[test]
3902 fn test_onchain_to_onchain_claim() {
3903         // Test that in case of channel closure, we detect the state of output thanks to
3904         // ChainWatchInterface and claim HTLC on downstream peer's remote commitment tx.
3905         // First, have C claim an HTLC against its own latest commitment transaction.
3906         // Then, broadcast these to B, which should update the monitor downstream on the A<->B
3907         // channel.
3908         // Finally, check that B will claim the HTLC output if A's latest commitment transaction
3909         // gets broadcast.
3910
3911         let nodes = create_network(3, &[None, None, None]);
3912
3913         // Create some initial channels
3914         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
3915         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
3916
3917         // Rebalance the network a bit by relaying one payment through all the channels ...
3918         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
3919         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 8000000, 8_000_000);
3920
3921         let (payment_preimage, _payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), 3000000);
3922         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
3923         let commitment_tx = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
3924         check_spends!(commitment_tx[0], chan_2.3.clone());
3925         nodes[2].node.claim_funds(payment_preimage, 3_000_000);
3926         check_added_monitors!(nodes[2], 1);
3927         let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
3928         assert!(updates.update_add_htlcs.is_empty());
3929         assert!(updates.update_fail_htlcs.is_empty());
3930         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
3931         assert!(updates.update_fail_malformed_htlcs.is_empty());
3932
3933         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
3934         check_closed_broadcast!(nodes[2]);
3935
3936         let c_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone(); // ChannelManager : 2 (commitment tx, HTLC-Success tx), ChannelMonitor : 1 (HTLC-Success tx)
3937         assert_eq!(c_txn.len(), 3);
3938         assert_eq!(c_txn[0], c_txn[2]);
3939         assert_eq!(commitment_tx[0], c_txn[1]);
3940         check_spends!(c_txn[1], chan_2.3.clone());
3941         check_spends!(c_txn[2], c_txn[1].clone());
3942         assert_eq!(c_txn[1].input[0].witness.clone().last().unwrap().len(), 71);
3943         assert_eq!(c_txn[2].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3944         assert!(c_txn[0].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
3945         assert_eq!(c_txn[0].lock_time, 0); // Success tx
3946
3947         // 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
3948         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![c_txn[1].clone(), c_txn[2].clone()]}, 1);
3949         {
3950                 let mut b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3951                 assert_eq!(b_txn.len(), 4);
3952                 assert_eq!(b_txn[0], b_txn[3]);
3953                 check_spends!(b_txn[1], chan_2.3); // B local commitment tx, issued by ChannelManager
3954                 check_spends!(b_txn[2], b_txn[1].clone()); // HTLC-Timeout on B local commitment tx, issued by ChannelManager
3955                 assert_eq!(b_txn[2].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3956                 assert!(b_txn[2].output[0].script_pubkey.is_v0_p2wsh()); // revokeable output
3957                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
3958                 check_spends!(b_txn[0], c_txn[1].clone()); // timeout tx on C remote commitment tx, issued by ChannelMonitor, * 2 due to block rescan
3959                 assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
3960                 assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
3961                 assert_ne!(b_txn[2].lock_time, 0); // Timeout tx
3962                 b_txn.clear();
3963         }
3964         let msg_events = nodes[1].node.get_and_clear_pending_msg_events();
3965         check_added_monitors!(nodes[1], 1);
3966         match msg_events[0] {
3967                 MessageSendEvent::BroadcastChannelUpdate {  .. } => {},
3968                 _ => panic!("Unexpected event"),
3969         }
3970         match msg_events[1] {
3971                 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, .. } } => {
3972                         assert!(update_add_htlcs.is_empty());
3973                         assert!(update_fail_htlcs.is_empty());
3974                         assert_eq!(update_fulfill_htlcs.len(), 1);
3975                         assert!(update_fail_malformed_htlcs.is_empty());
3976                         assert_eq!(nodes[0].node.get_our_node_id(), *node_id);
3977                 },
3978                 _ => panic!("Unexpected event"),
3979         };
3980         // Broadcast A's commitment tx on B's chain to see if we are able to claim inbound HTLC with our HTLC-Success tx
3981         let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
3982         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_tx[0].clone()]}, 1);
3983         let b_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3984         assert_eq!(b_txn.len(), 3);
3985         check_spends!(b_txn[1], chan_1.3); // Local commitment tx, issued by ChannelManager
3986         assert_eq!(b_txn[0], b_txn[2]); // HTLC-Success tx, issued by ChannelMonitor, * 2 due to block rescan
3987         check_spends!(b_txn[0], commitment_tx[0].clone());
3988         assert_eq!(b_txn[0].input[0].witness.clone().last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
3989         assert!(b_txn[0].output[0].script_pubkey.is_v0_p2wpkh()); // direct payment
3990         assert_eq!(b_txn[2].lock_time, 0); // Success tx
3991
3992         check_closed_broadcast!(nodes[1]);
3993 }
3994
3995 #[test]
3996 fn test_duplicate_payment_hash_one_failure_one_success() {
3997         // Topology : A --> B --> C
3998         // We route 2 payments with same hash between B and C, one will be timeout, the other successfully claim
3999         let mut nodes = create_network(3, &[None, None, None]);
4000
4001         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
4002         let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
4003
4004         let (our_payment_preimage, duplicate_payment_hash) = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000);
4005         *nodes[0].network_payment_count.borrow_mut() -= 1;
4006         assert_eq!(route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 900000).1, duplicate_payment_hash);
4007
4008         let commitment_txn = nodes[2].node.channel_state.lock().unwrap().by_id.get(&chan_2.2).unwrap().last_local_commitment_txn.clone();
4009         assert_eq!(commitment_txn[0].input.len(), 1);
4010         check_spends!(commitment_txn[0], chan_2.3.clone());
4011
4012         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4013         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4014         check_closed_broadcast!(nodes[1]);
4015
4016         let htlc_timeout_tx;
4017         { // Extract one of the two HTLC-Timeout transaction
4018                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4019                 assert_eq!(node_txn.len(), 7);
4020                 assert_eq!(node_txn[0], node_txn[5]);
4021                 assert_eq!(node_txn[1], node_txn[6]);
4022                 check_spends!(node_txn[0], commitment_txn[0].clone());
4023                 assert_eq!(node_txn[0].input.len(), 1);
4024                 check_spends!(node_txn[1], commitment_txn[0].clone());
4025                 assert_eq!(node_txn[1].input.len(), 1);
4026                 assert_ne!(node_txn[0].input[0], node_txn[1].input[0]);
4027                 check_spends!(node_txn[2], chan_2.3.clone());
4028                 check_spends!(node_txn[3], node_txn[2].clone());
4029                 check_spends!(node_txn[4], node_txn[2].clone());
4030                 htlc_timeout_tx = node_txn[1].clone();
4031         }
4032
4033         nodes[2].node.claim_funds(our_payment_preimage, 900_000);
4034         nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![commitment_txn[0].clone()] }, 1);
4035         check_added_monitors!(nodes[2], 2);
4036         let events = nodes[2].node.get_and_clear_pending_msg_events();
4037         match events[0] {
4038                 MessageSendEvent::UpdateHTLCs { .. } => {},
4039                 _ => panic!("Unexpected event"),
4040         }
4041         match events[1] {
4042                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4043                 _ => panic!("Unexepected event"),
4044         }
4045         let htlc_success_txn: Vec<_> = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
4046         assert_eq!(htlc_success_txn.len(), 5);
4047         check_spends!(htlc_success_txn[2], chan_2.3.clone());
4048         assert_eq!(htlc_success_txn[0], htlc_success_txn[3]);
4049         assert_eq!(htlc_success_txn[0].input.len(), 1);
4050         assert_eq!(htlc_success_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4051         assert_eq!(htlc_success_txn[1], htlc_success_txn[4]);
4052         assert_eq!(htlc_success_txn[1].input.len(), 1);
4053         assert_eq!(htlc_success_txn[1].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4054         assert_ne!(htlc_success_txn[0].input[0], htlc_success_txn[1].input[0]);
4055         check_spends!(htlc_success_txn[0], commitment_txn[0].clone());
4056         check_spends!(htlc_success_txn[1], commitment_txn[0].clone());
4057
4058         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_timeout_tx] }, 200);
4059         connect_blocks(&nodes[1].block_notifier, ANTI_REORG_DELAY - 1, 200, true, header.bitcoin_hash());
4060         expect_pending_htlcs_forwardable!(nodes[1]);
4061         let htlc_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4062         assert!(htlc_updates.update_add_htlcs.is_empty());
4063         assert_eq!(htlc_updates.update_fail_htlcs.len(), 1);
4064         assert_eq!(htlc_updates.update_fail_htlcs[0].htlc_id, 1);
4065         assert!(htlc_updates.update_fulfill_htlcs.is_empty());
4066         assert!(htlc_updates.update_fail_malformed_htlcs.is_empty());
4067         check_added_monitors!(nodes[1], 1);
4068
4069         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &htlc_updates.update_fail_htlcs[0]).unwrap();
4070         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4071         {
4072                 commitment_signed_dance!(nodes[0], nodes[1], &htlc_updates.commitment_signed, false, true);
4073                 let events = nodes[0].node.get_and_clear_pending_msg_events();
4074                 assert_eq!(events.len(), 1);
4075                 match events[0] {
4076                         MessageSendEvent::PaymentFailureNetworkUpdate { update: msgs::HTLCFailChannelUpdate::ChannelClosed { .. }  } => {
4077                         },
4078                         _ => { panic!("Unexpected event"); }
4079                 }
4080         }
4081         let events = nodes[0].node.get_and_clear_pending_events();
4082         match events[0] {
4083                 Event::PaymentFailed { ref payment_hash, .. } => {
4084                         assert_eq!(*payment_hash, duplicate_payment_hash);
4085                 }
4086                 _ => panic!("Unexpected event"),
4087         }
4088
4089         // Solve 2nd HTLC by broadcasting on B's chain HTLC-Success Tx from C
4090         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![htlc_success_txn[0].clone()] }, 200);
4091         let updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4092         assert!(updates.update_add_htlcs.is_empty());
4093         assert!(updates.update_fail_htlcs.is_empty());
4094         assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4095         assert_eq!(updates.update_fulfill_htlcs[0].htlc_id, 0);
4096         assert!(updates.update_fail_malformed_htlcs.is_empty());
4097         check_added_monitors!(nodes[1], 1);
4098
4099         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4100         commitment_signed_dance!(nodes[0], nodes[1], &updates.commitment_signed, false);
4101
4102         let events = nodes[0].node.get_and_clear_pending_events();
4103         match events[0] {
4104                 Event::PaymentSent { ref payment_preimage } => {
4105                         assert_eq!(*payment_preimage, our_payment_preimage);
4106                 }
4107                 _ => panic!("Unexpected event"),
4108         }
4109 }
4110
4111 #[test]
4112 fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
4113         let nodes = create_network(2, &[None, None]);
4114
4115         // Create some initial channels
4116         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
4117
4118         let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4119         let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4120         assert_eq!(local_txn[0].input.len(), 1);
4121         check_spends!(local_txn[0], chan_1.3.clone());
4122
4123         // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
4124         nodes[1].node.claim_funds(payment_preimage, 9_000_000);
4125         check_added_monitors!(nodes[1], 1);
4126         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4127         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
4128         let events = nodes[1].node.get_and_clear_pending_msg_events();
4129         match events[0] {
4130                 MessageSendEvent::UpdateHTLCs { .. } => {},
4131                 _ => panic!("Unexpected event"),
4132         }
4133         match events[1] {
4134                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
4135                 _ => panic!("Unexepected event"),
4136         }
4137         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4138         assert_eq!(node_txn[0].input.len(), 1);
4139         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
4140         check_spends!(node_txn[0], local_txn[0].clone());
4141
4142         // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
4143         let spend_txn = check_spendable_outputs!(nodes[1], 1);
4144         assert_eq!(spend_txn.len(), 2);
4145         check_spends!(spend_txn[0], node_txn[0].clone());
4146         check_spends!(spend_txn[1], node_txn[2].clone());
4147 }
4148
4149 fn do_test_fail_backwards_unrevoked_remote_announce(deliver_last_raa: bool, announce_latest: bool) {
4150         // Test that we fail backwards the full set of HTLCs we need to when remote broadcasts an
4151         // unrevoked commitment transaction.
4152         // This includes HTLCs which were below the dust threshold as well as HTLCs which were awaiting
4153         // a remote RAA before they could be failed backwards (and combinations thereof).
4154         // We also test duplicate-hash HTLCs by adding two nodes on each side of the target nodes which
4155         // use the same payment hashes.
4156         // Thus, we use a six-node network:
4157         //
4158         // A \         / E
4159         //    - C - D -
4160         // B /         \ F
4161         // And test where C fails back to A/B when D announces its latest commitment transaction
4162         let nodes = create_network(6, &[None, None, None, None, None, None]);
4163
4164         create_announced_chan_between_nodes(&nodes, 0, 2, LocalFeatures::new(), LocalFeatures::new());
4165         create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new());
4166         let chan = create_announced_chan_between_nodes(&nodes, 2, 3, LocalFeatures::new(), LocalFeatures::new());
4167         create_announced_chan_between_nodes(&nodes, 3, 4, LocalFeatures::new(), LocalFeatures::new());
4168         create_announced_chan_between_nodes(&nodes, 3, 5, LocalFeatures::new(), LocalFeatures::new());
4169
4170         // Rebalance and check output sanity...
4171         send_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 500000, 500_000);
4172         send_payment(&nodes[1], &[&nodes[2], &nodes[3], &nodes[5]], 500000, 500_000);
4173         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn[0].output.len(), 2);
4174
4175         let ds_dust_limit = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
4176         // 0th HTLC:
4177         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
4178         // 1st HTLC:
4179         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
4180         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();
4181         // 2nd HTLC:
4182         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
4183         // 3rd HTLC:
4184         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
4185         // 4th HTLC:
4186         let (_, payment_hash_3) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4187         // 5th HTLC:
4188         let (_, payment_hash_4) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4189         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4190         // 6th HTLC:
4191         send_along_route_with_hash(&nodes[1], route.clone(), &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_3);
4192         // 7th HTLC:
4193         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_4);
4194
4195         // 8th HTLC:
4196         let (_, payment_hash_5) = route_payment(&nodes[0], &[&nodes[2], &nodes[3], &nodes[4]], 1000000);
4197         // 9th HTLC:
4198         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();
4199         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
4200
4201         // 10th HTLC:
4202         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
4203         // 11th HTLC:
4204         let route = nodes[1].router.get_route(&nodes[5].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
4205         send_along_route_with_hash(&nodes[1], route, &[&nodes[2], &nodes[3], &nodes[5]], 1000000, payment_hash_6);
4206
4207         // Double-check that six of the new HTLC were added
4208         // We now have six HTLCs pending over the dust limit and six HTLCs under the dust limit (ie,
4209         // with to_local and to_remote outputs, 8 outputs and 6 HTLCs not included).
4210         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.len(), 1);
4211         assert_eq!(nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn[0].output.len(), 8);
4212
4213         // Now fail back three of the over-dust-limit and three of the under-dust-limit payments in one go.
4214         // Fail 0th below-dust, 4th above-dust, 8th above-dust, 10th below-dust HTLCs
4215         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_1));
4216         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_3));
4217         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_5));
4218         assert!(nodes[4].node.fail_htlc_backwards(&payment_hash_6));
4219         check_added_monitors!(nodes[4], 0);
4220         expect_pending_htlcs_forwardable!(nodes[4]);
4221         check_added_monitors!(nodes[4], 1);
4222
4223         let four_removes = get_htlc_update_msgs!(nodes[4], nodes[3].node.get_our_node_id());
4224         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[0]).unwrap();
4225         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[1]).unwrap();
4226         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[2]).unwrap();
4227         nodes[3].node.handle_update_fail_htlc(&nodes[4].node.get_our_node_id(), &four_removes.update_fail_htlcs[3]).unwrap();
4228         commitment_signed_dance!(nodes[3], nodes[4], four_removes.commitment_signed, false);
4229
4230         // Fail 3rd below-dust and 7th above-dust HTLCs
4231         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_2));
4232         assert!(nodes[5].node.fail_htlc_backwards(&payment_hash_4));
4233         check_added_monitors!(nodes[5], 0);
4234         expect_pending_htlcs_forwardable!(nodes[5]);
4235         check_added_monitors!(nodes[5], 1);
4236
4237         let two_removes = get_htlc_update_msgs!(nodes[5], nodes[3].node.get_our_node_id());
4238         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[0]).unwrap();
4239         nodes[3].node.handle_update_fail_htlc(&nodes[5].node.get_our_node_id(), &two_removes.update_fail_htlcs[1]).unwrap();
4240         commitment_signed_dance!(nodes[3], nodes[5], two_removes.commitment_signed, false);
4241
4242         let ds_prev_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
4243
4244         expect_pending_htlcs_forwardable!(nodes[3]);
4245         check_added_monitors!(nodes[3], 1);
4246         let six_removes = get_htlc_update_msgs!(nodes[3], nodes[2].node.get_our_node_id());
4247         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[0]).unwrap();
4248         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[1]).unwrap();
4249         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[2]).unwrap();
4250         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[3]).unwrap();
4251         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[4]).unwrap();
4252         nodes[2].node.handle_update_fail_htlc(&nodes[3].node.get_our_node_id(), &six_removes.update_fail_htlcs[5]).unwrap();
4253         if deliver_last_raa {
4254                 commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false);
4255         } else {
4256                 let _cs_last_raa = commitment_signed_dance!(nodes[2], nodes[3], six_removes.commitment_signed, false, true, false, true);
4257         }
4258
4259         // D's latest commitment transaction now contains 1st + 2nd + 9th HTLCs (implicitly, they're
4260         // below the dust limit) and the 5th + 6th + 11th HTLCs. It has failed back the 0th, 3rd, 4th,
4261         // 7th, 8th, and 10th, but as we haven't yet delivered the final RAA to C, the fails haven't
4262         // propagated back to A/B yet (and D has two unrevoked commitment transactions).
4263         //
4264         // We now broadcast the latest commitment transaction, which *should* result in failures for
4265         // the 0th, 1st, 2nd, 3rd, 4th, 7th, 8th, 9th, and 10th HTLCs, ie all the below-dust HTLCs and
4266         // the non-broadcast above-dust HTLCs.
4267         //
4268         // Alternatively, we may broadcast the previous commitment transaction, which should only
4269         // result in failures for the below-dust HTLCs, ie the 0th, 1st, 2nd, 3rd, 9th, and 10th HTLCs.
4270         let ds_last_commitment_tx = nodes[3].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
4271
4272         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4273         if announce_latest {
4274                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_last_commitment_tx[0].clone()]}, 1);
4275         } else {
4276                 nodes[2].block_notifier.block_connected(&Block { header, txdata: vec![ds_prev_commitment_tx[0].clone()]}, 1);
4277         }
4278         connect_blocks(&nodes[2].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
4279         check_closed_broadcast!(nodes[2]);
4280         expect_pending_htlcs_forwardable!(nodes[2]);
4281         check_added_monitors!(nodes[2], 2);
4282
4283         let cs_msgs = nodes[2].node.get_and_clear_pending_msg_events();
4284         assert_eq!(cs_msgs.len(), 2);
4285         let mut a_done = false;
4286         for msg in cs_msgs {
4287                 match msg {
4288                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
4289                                 // Both under-dust HTLCs and the one above-dust HTLC that we had already failed
4290                                 // should be failed-backwards here.
4291                                 let target = if *node_id == nodes[0].node.get_our_node_id() {
4292                                         // If announce_latest, expect 0th, 1st, 4th, 8th, 10th HTLCs, else only 0th, 1st, 10th below-dust HTLCs
4293                                         for htlc in &updates.update_fail_htlcs {
4294                                                 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 });
4295                                         }
4296                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 5 } else { 3 });
4297                                         assert!(!a_done);
4298                                         a_done = true;
4299                                         &nodes[0]
4300                                 } else {
4301                                         // If announce_latest, expect 2nd, 3rd, 7th, 9th HTLCs, else only 2nd, 3rd, 9th below-dust HTLCs
4302                                         for htlc in &updates.update_fail_htlcs {
4303                                                 assert!(htlc.htlc_id == 1 || htlc.htlc_id == 2 || htlc.htlc_id == 5 || if announce_latest { htlc.htlc_id == 4 } else { false });
4304                                         }
4305                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
4306                                         assert_eq!(updates.update_fail_htlcs.len(), if announce_latest { 4 } else { 3 });
4307                                         &nodes[1]
4308                                 };
4309                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
4310                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[1]).unwrap();
4311                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[2]).unwrap();
4312                                 if announce_latest {
4313                                         target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[3]).unwrap();
4314                                         if *node_id == nodes[0].node.get_our_node_id() {
4315                                                 target.node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[4]).unwrap();
4316                                         }
4317                                 }
4318                                 commitment_signed_dance!(target, nodes[2], updates.commitment_signed, false, true);
4319                         },
4320                         _ => panic!("Unexpected event"),
4321                 }
4322         }
4323
4324         let as_events = nodes[0].node.get_and_clear_pending_events();
4325         assert_eq!(as_events.len(), if announce_latest { 5 } else { 3 });
4326         let mut as_failds = HashSet::new();
4327         for event in as_events.iter() {
4328                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4329                         assert!(as_failds.insert(*payment_hash));
4330                         if *payment_hash != payment_hash_2 {
4331                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4332                         } else {
4333                                 assert!(!rejected_by_dest);
4334                         }
4335                 } else { panic!("Unexpected event"); }
4336         }
4337         assert!(as_failds.contains(&payment_hash_1));
4338         assert!(as_failds.contains(&payment_hash_2));
4339         if announce_latest {
4340                 assert!(as_failds.contains(&payment_hash_3));
4341                 assert!(as_failds.contains(&payment_hash_5));
4342         }
4343         assert!(as_failds.contains(&payment_hash_6));
4344
4345         let bs_events = nodes[1].node.get_and_clear_pending_events();
4346         assert_eq!(bs_events.len(), if announce_latest { 4 } else { 3 });
4347         let mut bs_failds = HashSet::new();
4348         for event in bs_events.iter() {
4349                 if let &Event::PaymentFailed { ref payment_hash, ref rejected_by_dest, .. } = event {
4350                         assert!(bs_failds.insert(*payment_hash));
4351                         if *payment_hash != payment_hash_1 && *payment_hash != payment_hash_5 {
4352                                 assert_eq!(*rejected_by_dest, deliver_last_raa);
4353                         } else {
4354                                 assert!(!rejected_by_dest);
4355                         }
4356                 } else { panic!("Unexpected event"); }
4357         }
4358         assert!(bs_failds.contains(&payment_hash_1));
4359         assert!(bs_failds.contains(&payment_hash_2));
4360         if announce_latest {
4361                 assert!(bs_failds.contains(&payment_hash_4));
4362         }
4363         assert!(bs_failds.contains(&payment_hash_5));
4364
4365         // For each HTLC which was not failed-back by normal process (ie deliver_last_raa), we should
4366         // get a PaymentFailureNetworkUpdate. A should have gotten 4 HTLCs which were failed-back due
4367         // to unknown-preimage-etc, B should have gotten 2. Thus, in the
4368         // announce_latest && deliver_last_raa case, we should have 5-4=1 and 4-2=2
4369         // PaymentFailureNetworkUpdates.
4370         let as_msg_events = nodes[0].node.get_and_clear_pending_msg_events();
4371         assert_eq!(as_msg_events.len(), if deliver_last_raa { 1 } else if !announce_latest { 3 } else { 5 });
4372         let bs_msg_events = nodes[1].node.get_and_clear_pending_msg_events();
4373         assert_eq!(bs_msg_events.len(), if deliver_last_raa { 2 } else if !announce_latest { 3 } else { 4 });
4374         for event in as_msg_events.iter().chain(bs_msg_events.iter()) {
4375                 match event {
4376                         &MessageSendEvent::PaymentFailureNetworkUpdate { .. } => {},
4377                         _ => panic!("Unexpected event"),
4378                 }
4379         }
4380 }
4381
4382 #[test]
4383 fn test_fail_backwards_latest_remote_announce_a() {
4384         do_test_fail_backwards_unrevoked_remote_announce(false, true);
4385 }
4386
4387 #[test]
4388 fn test_fail_backwards_latest_remote_announce_b() {
4389         do_test_fail_backwards_unrevoked_remote_announce(true, true);
4390 }
4391
4392 #[test]
4393 fn test_fail_backwards_previous_remote_announce() {
4394         do_test_fail_backwards_unrevoked_remote_announce(false, false);
4395         // Note that true, true doesn't make sense as it implies we announce a revoked state, which is
4396         // tested for in test_commitment_revoked_fail_backward_exhaustive()
4397 }
4398
4399 #[test]
4400 fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
4401         let nodes = create_network(2, &[None, None]);
4402
4403         // Create some initial channels
4404         let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
4405
4406         route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
4407         let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4408         assert_eq!(local_txn[0].input.len(), 1);
4409         check_spends!(local_txn[0], chan_1.3.clone());
4410
4411         // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
4412         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4413         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
4414         check_closed_broadcast!(nodes[0]);
4415
4416         let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
4417         assert_eq!(node_txn[0].input.len(), 1);
4418         assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
4419         check_spends!(node_txn[0], local_txn[0].clone());
4420
4421         // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
4422         let spend_txn = check_spendable_outputs!(nodes[0], 1);
4423         assert_eq!(spend_txn.len(), 8);
4424         assert_eq!(spend_txn[0], spend_txn[2]);
4425         assert_eq!(spend_txn[0], spend_txn[4]);
4426         assert_eq!(spend_txn[0], spend_txn[6]);
4427         assert_eq!(spend_txn[1], spend_txn[3]);
4428         assert_eq!(spend_txn[1], spend_txn[5]);
4429         assert_eq!(spend_txn[1], spend_txn[7]);
4430         check_spends!(spend_txn[0], local_txn[0].clone());
4431         check_spends!(spend_txn[1], node_txn[0].clone());
4432 }
4433
4434 #[test]
4435 fn test_static_output_closing_tx() {
4436         let nodes = create_network(2, &[None, None]);
4437
4438         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
4439
4440         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
4441         let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
4442
4443         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4444         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4445         let spend_txn = check_spendable_outputs!(nodes[0], 2);
4446         assert_eq!(spend_txn.len(), 1);
4447         check_spends!(spend_txn[0], closing_tx.clone());
4448
4449         nodes[1].block_notifier.block_connected(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
4450         let spend_txn = check_spendable_outputs!(nodes[1], 2);
4451         assert_eq!(spend_txn.len(), 1);
4452         check_spends!(spend_txn[0], closing_tx);
4453 }
4454
4455 fn do_htlc_claim_local_commitment_only(use_dust: bool) {
4456         let nodes = create_network(2, &[None, None]);
4457         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
4458
4459         let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], if use_dust { 50000 } else { 3000000 });
4460
4461         // Claim the payment, but don't deliver A's commitment_signed, resulting in the HTLC only being
4462         // present in B's local commitment transaction, but none of A's commitment transactions.
4463         assert!(nodes[1].node.claim_funds(our_payment_preimage, if use_dust { 50_000 } else { 3_000_000 }));
4464         check_added_monitors!(nodes[1], 1);
4465
4466         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4467         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fulfill_htlcs[0]).unwrap();
4468         let events = nodes[0].node.get_and_clear_pending_events();
4469         assert_eq!(events.len(), 1);
4470         match events[0] {
4471                 Event::PaymentSent { payment_preimage } => {
4472                         assert_eq!(payment_preimage, our_payment_preimage);
4473                 },
4474                 _ => panic!("Unexpected event"),
4475         }
4476
4477         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed).unwrap();
4478         check_added_monitors!(nodes[0], 1);
4479         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4480         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0).unwrap();
4481         check_added_monitors!(nodes[1], 1);
4482
4483         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4484         for i in 1..TEST_FINAL_CLTV - CLTV_CLAIM_BUFFER + CHAN_CONFIRM_DEPTH + 1 {
4485                 nodes[1].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4486                 header.prev_blockhash = header.bitcoin_hash();
4487         }
4488         test_txn_broadcast(&nodes[1], &chan, None, if use_dust { HTLCType::NONE } else { HTLCType::SUCCESS });
4489         check_closed_broadcast!(nodes[1]);
4490 }
4491
4492 fn do_htlc_claim_current_remote_commitment_only(use_dust: bool) {
4493         let mut nodes = create_network(2, &[None, None]);
4494         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
4495
4496         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();
4497         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4498         nodes[0].node.send_payment(route, payment_hash).unwrap();
4499         check_added_monitors!(nodes[0], 1);
4500
4501         let _as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4502
4503         // As far as A is concerned, the HTLC is now present only in the latest remote commitment
4504         // transaction, however it is not in A's latest local commitment, so we can just broadcast that
4505         // to "time out" the HTLC.
4506
4507         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4508
4509         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4510                 nodes[0].block_notifier.block_connected(&Block { header, txdata: Vec::new()}, i);
4511                 header.prev_blockhash = header.bitcoin_hash();
4512         }
4513         test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4514         check_closed_broadcast!(nodes[0]);
4515 }
4516
4517 fn do_htlc_claim_previous_remote_commitment_only(use_dust: bool, check_revoke_no_close: bool) {
4518         let nodes = create_network(3, &[None, None, None]);
4519         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
4520
4521         // Fail the payment, but don't deliver A's final RAA, resulting in the HTLC only being present
4522         // in B's previous (unrevoked) commitment transaction, but none of A's commitment transactions.
4523         // Also optionally test that we *don't* fail the channel in case the commitment transaction was
4524         // actually revoked.
4525         let htlc_value = if use_dust { 50000 } else { 3000000 };
4526         let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], htlc_value);
4527         assert!(nodes[1].node.fail_htlc_backwards(&our_payment_hash));
4528         expect_pending_htlcs_forwardable!(nodes[1]);
4529         check_added_monitors!(nodes[1], 1);
4530
4531         let bs_updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4532         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &bs_updates.update_fail_htlcs[0]).unwrap();
4533         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_updates.commitment_signed).unwrap();
4534         check_added_monitors!(nodes[0], 1);
4535         let as_updates = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4536         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_updates.0).unwrap();
4537         check_added_monitors!(nodes[1], 1);
4538         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_updates.1).unwrap();
4539         check_added_monitors!(nodes[1], 1);
4540         let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4541
4542         if check_revoke_no_close {
4543                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
4544                 check_added_monitors!(nodes[0], 1);
4545         }
4546
4547         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4548         for i in 1..TEST_FINAL_CLTV + LATENCY_GRACE_PERIOD_BLOCKS + CHAN_CONFIRM_DEPTH + 1 {
4549                 nodes[0].block_notifier.block_connected_checked(&header, i, &Vec::new(), &Vec::new());
4550                 header.prev_blockhash = header.bitcoin_hash();
4551         }
4552         if !check_revoke_no_close {
4553                 test_txn_broadcast(&nodes[0], &chan, None, HTLCType::NONE);
4554                 check_closed_broadcast!(nodes[0]);
4555         } else {
4556                 let events = nodes[0].node.get_and_clear_pending_events();
4557                 assert_eq!(events.len(), 1);
4558                 match events[0] {
4559                         Event::PaymentFailed { payment_hash, rejected_by_dest, .. } => {
4560                                 assert_eq!(payment_hash, our_payment_hash);
4561                                 assert!(rejected_by_dest);
4562                         },
4563                         _ => panic!("Unexpected event"),
4564                 }
4565         }
4566 }
4567
4568 // Test that we close channels on-chain when broadcastable HTLCs reach their timeout window.
4569 // There are only a few cases to test here:
4570 //  * its not really normative behavior, but we test that below-dust HTLCs "included" in
4571 //    broadcastable commitment transactions result in channel closure,
4572 //  * its included in an unrevoked-but-previous remote commitment transaction,
4573 //  * its included in the latest remote or local commitment transactions.
4574 // We test each of the three possible commitment transactions individually and use both dust and
4575 // non-dust HTLCs.
4576 // Note that we don't bother testing both outbound and inbound HTLC failures for each case, and we
4577 // assume they are handled the same across all six cases, as both outbound and inbound failures are
4578 // tested for at least one of the cases in other tests.
4579 #[test]
4580 fn htlc_claim_single_commitment_only_a() {
4581         do_htlc_claim_local_commitment_only(true);
4582         do_htlc_claim_local_commitment_only(false);
4583
4584         do_htlc_claim_current_remote_commitment_only(true);
4585         do_htlc_claim_current_remote_commitment_only(false);
4586 }
4587
4588 #[test]
4589 fn htlc_claim_single_commitment_only_b() {
4590         do_htlc_claim_previous_remote_commitment_only(true, false);
4591         do_htlc_claim_previous_remote_commitment_only(false, false);
4592         do_htlc_claim_previous_remote_commitment_only(true, true);
4593         do_htlc_claim_previous_remote_commitment_only(false, true);
4594 }
4595
4596 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>)
4597         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4598                                 F2: FnMut(),
4599 {
4600         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);
4601 }
4602
4603 // test_case
4604 // 0: node1 fails backward
4605 // 1: final node fails backward
4606 // 2: payment completed but the user rejects the payment
4607 // 3: final node fails backward (but tamper onion payloads from node0)
4608 // 100: trigger error in the intermediate node and tamper returning fail_htlc
4609 // 200: trigger error in the final node and tamper returning fail_htlc
4610 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>)
4611         where F1: for <'a> FnMut(&'a mut msgs::UpdateAddHTLC),
4612                                 F2: for <'a> FnMut(&'a mut msgs::UpdateFailHTLC),
4613                                 F3: FnMut(),
4614 {
4615
4616         // reset block height
4617         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4618         for ix in 0..nodes.len() {
4619                 nodes[ix].block_notifier.block_connected_checked(&header, 1, &[], &[]);
4620         }
4621
4622         macro_rules! expect_event {
4623                 ($node: expr, $event_type: path) => {{
4624                         let events = $node.node.get_and_clear_pending_events();
4625                         assert_eq!(events.len(), 1);
4626                         match events[0] {
4627                                 $event_type { .. } => {},
4628                                 _ => panic!("Unexpected event"),
4629                         }
4630                 }}
4631         }
4632
4633         macro_rules! expect_htlc_forward {
4634                 ($node: expr) => {{
4635                         expect_event!($node, Event::PendingHTLCsForwardable);
4636                         $node.node.process_pending_htlc_forwards();
4637                 }}
4638         }
4639
4640         // 0 ~~> 2 send payment
4641         nodes[0].node.send_payment(route.clone(), payment_hash.clone()).unwrap();
4642         check_added_monitors!(nodes[0], 1);
4643         let update_0 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4644         // temper update_add (0 => 1)
4645         let mut update_add_0 = update_0.update_add_htlcs[0].clone();
4646         if test_case == 0 || test_case == 3 || test_case == 100 {
4647                 callback_msg(&mut update_add_0);
4648                 callback_node();
4649         }
4650         // 0 => 1 update_add & CS
4651         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &update_add_0).unwrap();
4652         commitment_signed_dance!(nodes[1], nodes[0], &update_0.commitment_signed, false, true);
4653
4654         let update_1_0 = match test_case {
4655                 0|100 => { // intermediate node failure; fail backward to 0
4656                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4657                         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));
4658                         update_1_0
4659                 },
4660                 1|2|3|200 => { // final node failure; forwarding to 2
4661                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4662                         // forwarding on 1
4663                         if test_case != 200 {
4664                                 callback_node();
4665                         }
4666                         expect_htlc_forward!(&nodes[1]);
4667
4668                         let update_1 = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
4669                         check_added_monitors!(&nodes[1], 1);
4670                         assert_eq!(update_1.update_add_htlcs.len(), 1);
4671                         // tamper update_add (1 => 2)
4672                         let mut update_add_1 = update_1.update_add_htlcs[0].clone();
4673                         if test_case != 3 && test_case != 200 {
4674                                 callback_msg(&mut update_add_1);
4675                         }
4676
4677                         // 1 => 2
4678                         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &update_add_1).unwrap();
4679                         commitment_signed_dance!(nodes[2], nodes[1], update_1.commitment_signed, false, true);
4680
4681                         if test_case == 2 || test_case == 200 {
4682                                 expect_htlc_forward!(&nodes[2]);
4683                                 expect_event!(&nodes[2], Event::PaymentReceived);
4684                                 callback_node();
4685                                 expect_pending_htlcs_forwardable!(nodes[2]);
4686                         }
4687
4688                         let update_2_1 = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4689                         if test_case == 2 || test_case == 200 {
4690                                 check_added_monitors!(&nodes[2], 1);
4691                         }
4692                         assert!(update_2_1.update_fail_htlcs.len() == 1);
4693
4694                         let mut fail_msg = update_2_1.update_fail_htlcs[0].clone();
4695                         if test_case == 200 {
4696                                 callback_fail(&mut fail_msg);
4697                         }
4698
4699                         // 2 => 1
4700                         nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &fail_msg).unwrap();
4701                         commitment_signed_dance!(nodes[1], nodes[2], update_2_1.commitment_signed, true);
4702
4703                         // backward fail on 1
4704                         let update_1_0 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4705                         assert!(update_1_0.update_fail_htlcs.len() == 1);
4706                         update_1_0
4707                 },
4708                 _ => unreachable!(),
4709         };
4710
4711         // 1 => 0 commitment_signed_dance
4712         if update_1_0.update_fail_htlcs.len() > 0 {
4713                 let mut fail_msg = update_1_0.update_fail_htlcs[0].clone();
4714                 if test_case == 100 {
4715                         callback_fail(&mut fail_msg);
4716                 }
4717                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &fail_msg).unwrap();
4718         } else {
4719                 nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_1_0.update_fail_malformed_htlcs[0]).unwrap();
4720         };
4721
4722         commitment_signed_dance!(nodes[0], nodes[1], update_1_0.commitment_signed, false, true);
4723
4724         let events = nodes[0].node.get_and_clear_pending_events();
4725         assert_eq!(events.len(), 1);
4726         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
4727                 assert_eq!(*rejected_by_dest, !expected_retryable);
4728                 assert_eq!(*error_code, expected_error_code);
4729         } else {
4730                 panic!("Uexpected event");
4731         }
4732
4733         let events = nodes[0].node.get_and_clear_pending_msg_events();
4734         if expected_channel_update.is_some() {
4735                 assert_eq!(events.len(), 1);
4736                 match events[0] {
4737                         MessageSendEvent::PaymentFailureNetworkUpdate { ref update } => {
4738                                 match update {
4739                                         &HTLCFailChannelUpdate::ChannelUpdateMessage { .. } => {
4740                                                 if let HTLCFailChannelUpdate::ChannelUpdateMessage { .. } = expected_channel_update.unwrap() {} else {
4741                                                         panic!("channel_update not found!");
4742                                                 }
4743                                         },
4744                                         &HTLCFailChannelUpdate::ChannelClosed { ref short_channel_id, ref is_permanent } => {
4745                                                 if let HTLCFailChannelUpdate::ChannelClosed { short_channel_id: ref expected_short_channel_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4746                                                         assert!(*short_channel_id == *expected_short_channel_id);
4747                                                         assert!(*is_permanent == *expected_is_permanent);
4748                                                 } else {
4749                                                         panic!("Unexpected message event");
4750                                                 }
4751                                         },
4752                                         &HTLCFailChannelUpdate::NodeFailure { ref node_id, ref is_permanent } => {
4753                                                 if let HTLCFailChannelUpdate::NodeFailure { node_id: ref expected_node_id, is_permanent: ref expected_is_permanent } = expected_channel_update.unwrap() {
4754                                                         assert!(*node_id == *expected_node_id);
4755                                                         assert!(*is_permanent == *expected_is_permanent);
4756                                                 } else {
4757                                                         panic!("Unexpected message event");
4758                                                 }
4759                                         },
4760                                 }
4761                         },
4762                         _ => panic!("Unexpected message event"),
4763                 }
4764         } else {
4765                 assert_eq!(events.len(), 0);
4766         }
4767 }
4768
4769 impl msgs::ChannelUpdate {
4770         fn dummy() -> msgs::ChannelUpdate {
4771                 use secp256k1::ffi::Signature as FFISignature;
4772                 use secp256k1::Signature;
4773                 msgs::ChannelUpdate {
4774                         signature: Signature::from(FFISignature::new()),
4775                         contents: msgs::UnsignedChannelUpdate {
4776                                 chain_hash: Sha256dHash::hash(&vec![0u8][..]),
4777                                 short_channel_id: 0,
4778                                 timestamp: 0,
4779                                 flags: 0,
4780                                 cltv_expiry_delta: 0,
4781                                 htlc_minimum_msat: 0,
4782                                 fee_base_msat: 0,
4783                                 fee_proportional_millionths: 0,
4784                                 excess_data: vec![],
4785                         }
4786                 }
4787         }
4788 }
4789
4790 #[test]
4791 fn test_onion_failure() {
4792         use ln::msgs::ChannelUpdate;
4793         use ln::channelmanager::CLTV_FAR_FAR_AWAY;
4794         use secp256k1;
4795
4796         const BADONION: u16 = 0x8000;
4797         const PERM: u16 = 0x4000;
4798         const NODE: u16 = 0x2000;
4799         const UPDATE: u16 = 0x1000;
4800
4801         let mut nodes = create_network(3, &[None, None, None]);
4802         for node in nodes.iter() {
4803                 *node.keys_manager.override_session_priv.lock().unwrap() = Some(SecretKey::from_slice(&[3; 32]).unwrap());
4804         }
4805         let channels = [create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new()), create_announced_chan_between_nodes(&nodes, 1, 2, LocalFeatures::new(), LocalFeatures::new())];
4806         let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4807         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap();
4808         // positve case
4809         send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 40000, 40_000);
4810
4811         // intermediate node failure
4812         run_onion_failure_test("invalid_realm", 0, &nodes, &route, &payment_hash, |msg| {
4813                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4814                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4815                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4816                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
4817                 onion_payloads[0].realm = 3;
4818                 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
4819         }, ||{}, true, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));//XXX incremented channels idx here
4820
4821         // final node failure
4822         run_onion_failure_test("invalid_realm", 3, &nodes, &route, &payment_hash, |msg| {
4823                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4824                 let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4825                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4826                 let (mut onion_payloads, _htlc_msat, _htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
4827                 onion_payloads[1].realm = 3;
4828                 msg.onion_routing_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
4829         }, ||{}, false, Some(PERM|1), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4830
4831         // the following three with run_onion_failure_test_with_fail_intercept() test only the origin node
4832         // receiving simulated fail messages
4833         // intermediate node failure
4834         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
4835                 // trigger error
4836                 msg.amount_msat -= 1;
4837         }, |msg| {
4838                 // and tamper returning error message
4839                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4840                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4841                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], NODE|2, &[0;0]);
4842         }, ||{}, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: false}));
4843
4844         // final node failure
4845         run_onion_failure_test_with_fail_intercept("temporary_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4846                 // and tamper returning error message
4847                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4848                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4849                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], NODE|2, &[0;0]);
4850         }, ||{
4851                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4852         }, true, Some(NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: false}));
4853
4854         // intermediate node failure
4855         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 100, &nodes, &route, &payment_hash, |msg| {
4856                 msg.amount_msat -= 1;
4857         }, |msg| {
4858                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4859                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4860                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|2, &[0;0]);
4861         }, ||{}, true, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
4862
4863         // final node failure
4864         run_onion_failure_test_with_fail_intercept("permanent_node_failure", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4865                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4866                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4867                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|2, &[0;0]);
4868         }, ||{
4869                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4870         }, false, Some(PERM|NODE|2), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
4871
4872         // intermediate node failure
4873         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
4874                 msg.amount_msat -= 1;
4875         }, |msg| {
4876                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4877                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4878                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|NODE|3, &[0;0]);
4879         }, ||{
4880                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4881         }, true, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[0].pubkey, is_permanent: true}));
4882
4883         // final node failure
4884         run_onion_failure_test_with_fail_intercept("required_node_feature_missing", 200, &nodes, &route, &payment_hash, |_msg| {}, |msg| {
4885                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4886                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4887                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[1].shared_secret[..], PERM|NODE|3, &[0;0]);
4888         }, ||{
4889                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4890         }, false, Some(PERM|NODE|3), Some(msgs::HTLCFailChannelUpdate::NodeFailure{node_id: route.hops[1].pubkey, is_permanent: true}));
4891
4892         run_onion_failure_test("invalid_onion_version", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.version = 1; }, ||{}, true,
4893                 Some(BADONION|PERM|4), None);
4894
4895         run_onion_failure_test("invalid_onion_hmac", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.hmac = [3; 32]; }, ||{}, true,
4896                 Some(BADONION|PERM|5), None);
4897
4898         run_onion_failure_test("invalid_onion_key", 0, &nodes, &route, &payment_hash, |msg| { msg.onion_routing_packet.public_key = Err(secp256k1::Error::InvalidPublicKey);}, ||{}, true,
4899                 Some(BADONION|PERM|6), None);
4900
4901         run_onion_failure_test_with_fail_intercept("temporary_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
4902                 msg.amount_msat -= 1;
4903         }, |msg| {
4904                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4905                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4906                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], UPDATE|7, &ChannelUpdate::dummy().encode_with_len()[..]);
4907         }, ||{}, true, Some(UPDATE|7), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4908
4909         run_onion_failure_test_with_fail_intercept("permanent_channel_failure", 100, &nodes, &route, &payment_hash, |msg| {
4910                 msg.amount_msat -= 1;
4911         }, |msg| {
4912                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4913                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4914                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|8, &[0;0]);
4915                 // short_channel_id from the processing node
4916         }, ||{}, true, Some(PERM|8), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4917
4918         run_onion_failure_test_with_fail_intercept("required_channel_feature_missing", 100, &nodes, &route, &payment_hash, |msg| {
4919                 msg.amount_msat -= 1;
4920         }, |msg| {
4921                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
4922                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
4923                 msg.reason = onion_utils::build_first_hop_failure_packet(&onion_keys[0].shared_secret[..], PERM|9, &[0;0]);
4924                 // short_channel_id from the processing node
4925         }, ||{}, true, Some(PERM|9), Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: channels[1].0.contents.short_channel_id, is_permanent: true}));
4926
4927         let mut bogus_route = route.clone();
4928         bogus_route.hops[1].short_channel_id -= 1;
4929         run_onion_failure_test("unknown_next_peer", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(PERM|10),
4930           Some(msgs::HTLCFailChannelUpdate::ChannelClosed{short_channel_id: bogus_route.hops[1].short_channel_id, is_permanent:true}));
4931
4932         let amt_to_forward = nodes[1].node.channel_state.lock().unwrap().by_id.get(&channels[1].2).unwrap().get_their_htlc_minimum_msat() - 1;
4933         let mut bogus_route = route.clone();
4934         let route_len = bogus_route.hops.len();
4935         bogus_route.hops[route_len-1].fee_msat = amt_to_forward;
4936         run_onion_failure_test("amount_below_minimum", 0, &nodes, &bogus_route, &payment_hash, |_| {}, ||{}, true, Some(UPDATE|11), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4937
4938         //TODO: with new config API, we will be able to generate both valid and
4939         //invalid channel_update cases.
4940         run_onion_failure_test("fee_insufficient", 0, &nodes, &route, &payment_hash, |msg| {
4941                 msg.amount_msat -= 1;
4942         }, || {}, true, Some(UPDATE|12), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
4943
4944         run_onion_failure_test("incorrect_cltv_expiry", 0, &nodes, &route, &payment_hash, |msg| {
4945                 // need to violate: cltv_expiry - cltv_expiry_delta >= outgoing_cltv_value
4946                 msg.cltv_expiry -= 1;
4947         }, || {}, true, Some(UPDATE|13), Some(msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id: channels[0].0.contents.short_channel_id, is_permanent: true}));
4948
4949         run_onion_failure_test("expiry_too_soon", 0, &nodes, &route, &payment_hash, |msg| {
4950                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
4951                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4952
4953                 nodes[1].block_notifier.block_connected_checked(&header, height, &[], &[]);
4954         }, ||{}, true, Some(UPDATE|14), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4955
4956         run_onion_failure_test("unknown_payment_hash", 2, &nodes, &route, &payment_hash, |_| {}, || {
4957                 nodes[2].node.fail_htlc_backwards(&payment_hash);
4958         }, false, Some(PERM|15), None);
4959
4960         run_onion_failure_test("final_expiry_too_soon", 1, &nodes, &route, &payment_hash, |msg| {
4961                 let height = msg.cltv_expiry - CLTV_CLAIM_BUFFER - LATENCY_GRACE_PERIOD_BLOCKS + 1;
4962                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4963
4964                 nodes[2].block_notifier.block_connected_checked(&header, height, &[], &[]);
4965         }, || {}, true, Some(17), None);
4966
4967         run_onion_failure_test("final_incorrect_cltv_expiry", 1, &nodes, &route, &payment_hash, |_| {}, || {
4968                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
4969                         for f in pending_forwards.iter_mut() {
4970                                 match f {
4971                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
4972                                                 forward_info.outgoing_cltv_value += 1,
4973                                         _ => {},
4974                                 }
4975                         }
4976                 }
4977         }, true, Some(18), None);
4978
4979         run_onion_failure_test("final_incorrect_htlc_amount", 1, &nodes, &route, &payment_hash, |_| {}, || {
4980                 // violate amt_to_forward > msg.amount_msat
4981                 for (_, pending_forwards) in nodes[1].node.channel_state.lock().unwrap().borrow_parts().forward_htlcs.iter_mut() {
4982                         for f in pending_forwards.iter_mut() {
4983                                 match f {
4984                                         &mut HTLCForwardInfo::AddHTLC { ref mut forward_info, .. } =>
4985                                                 forward_info.amt_to_forward -= 1,
4986                                         _ => {},
4987                                 }
4988                         }
4989                 }
4990         }, true, Some(19), None);
4991
4992         run_onion_failure_test("channel_disabled", 0, &nodes, &route, &payment_hash, |_| {}, || {
4993                 // disconnect event to the channel between nodes[1] ~ nodes[2]
4994                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), false);
4995                 nodes[2].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
4996         }, true, Some(UPDATE|20), Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage{msg: ChannelUpdate::dummy()}));
4997         reconnect_nodes(&nodes[1], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
4998
4999         run_onion_failure_test("expiry_too_far", 0, &nodes, &route, &payment_hash, |msg| {
5000                 let session_priv = SecretKey::from_slice(&[3; 32]).unwrap();
5001                 let mut route = route.clone();
5002                 let height = 1;
5003                 route.hops[1].cltv_expiry_delta += CLTV_FAR_FAR_AWAY + route.hops[0].cltv_expiry_delta + 1;
5004                 let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::new(), &route, &session_priv).unwrap();
5005                 let (onion_payloads, _, htlc_cltv) = onion_utils::build_onion_payloads(&route, height).unwrap();
5006                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
5007                 msg.cltv_expiry = htlc_cltv;
5008                 msg.onion_routing_packet = onion_packet;
5009         }, ||{}, true, Some(21), None);
5010 }
5011
5012 #[test]
5013 #[should_panic]
5014 fn bolt2_open_channel_sending_node_checks_part1() { //This test needs to be on its own as we are catching a panic
5015         let nodes = create_network(2, &[None, None]);
5016         //Force duplicate channel ids
5017         for node in nodes.iter() {
5018                 *node.keys_manager.override_channel_id_priv.lock().unwrap() = Some([0; 32]);
5019         }
5020
5021         // BOLT #2 spec: Sending node must ensure temporary_channel_id is unique from any other channel ID with the same peer.
5022         let channel_value_satoshis=10000;
5023         let push_msat=10001;
5024         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).unwrap();
5025         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5026         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), LocalFeatures::new(), &node0_to_1_send_open_channel).unwrap();
5027
5028         //Create a second channel with a channel_id collision
5029         assert!(nodes[0].node.create_channel(nodes[0].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5030 }
5031
5032 #[test]
5033 fn bolt2_open_channel_sending_node_checks_part2() {
5034         let nodes = create_network(2, &[None, None]);
5035
5036         // BOLT #2 spec: Sending node must set funding_satoshis to less than 2^24 satoshis
5037         let channel_value_satoshis=2^24;
5038         let push_msat=10001;
5039         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5040
5041         // BOLT #2 spec: Sending node must set push_msat to equal or less than 1000 * funding_satoshis
5042         let channel_value_satoshis=10000;
5043         // Test when push_msat is equal to 1000 * funding_satoshis.
5044         let push_msat=1000*channel_value_satoshis+1;
5045         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_err());
5046
5047         // BOLT #2 spec: Sending node must set set channel_reserve_satoshis greater than or equal to dust_limit_satoshis
5048         let channel_value_satoshis=10000;
5049         let push_msat=10001;
5050         assert!(nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), channel_value_satoshis, push_msat, 42).is_ok()); //Create a valid channel
5051         let node0_to_1_send_open_channel = get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id());
5052         assert!(node0_to_1_send_open_channel.channel_reserve_satoshis>=node0_to_1_send_open_channel.dust_limit_satoshis);
5053
5054         // BOLT #2 spec: Sending node must set undefined bits in channel_flags to 0
5055         // 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
5056         assert!(node0_to_1_send_open_channel.channel_flags<=1);
5057
5058         // 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.
5059         assert!(BREAKDOWN_TIMEOUT>0);
5060         assert!(node0_to_1_send_open_channel.to_self_delay==BREAKDOWN_TIMEOUT);
5061
5062         // BOLT #2 spec: Sending node must ensure the chain_hash value identifies the chain it wishes to open the channel within.
5063         let chain_hash=genesis_block(Network::Testnet).header.bitcoin_hash();
5064         assert_eq!(node0_to_1_send_open_channel.chain_hash,chain_hash);
5065
5066         // 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.
5067         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.funding_pubkey.serialize()).is_ok());
5068         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.revocation_basepoint.serialize()).is_ok());
5069         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.htlc_basepoint.serialize()).is_ok());
5070         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.payment_basepoint.serialize()).is_ok());
5071         assert!(PublicKey::from_slice(&node0_to_1_send_open_channel.delayed_payment_basepoint.serialize()).is_ok());
5072 }
5073
5074 // BOLT 2 Requirements for the Sender when constructing and sending an update_add_htlc message.
5075 // 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.
5076 //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.
5077
5078 #[test]
5079 fn test_update_add_htlc_bolt2_sender_value_below_minimum_msat() {
5080         //BOLT2 Requirement: MUST offer amount_msat greater than 0.
5081         //BOLT2 Requirement: MUST NOT offer amount_msat below the receiving node's htlc_minimum_msat (same validation check catches both of these)
5082         let mut nodes = create_network(2, &[None, None]);
5083         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, LocalFeatures::new(), LocalFeatures::new());
5084         let mut route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5085         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5086
5087         route.hops[0].fee_msat = 0;
5088
5089         let err = nodes[0].node.send_payment(route, our_payment_hash);
5090
5091         if let Err(APIError::ChannelUnavailable{err}) = err {
5092                 assert_eq!(err, "Cannot send less than their minimum HTLC value");
5093         } else {
5094                 assert!(false);
5095         }
5096 }
5097
5098 #[test]
5099 fn test_update_add_htlc_bolt2_sender_cltv_expiry_too_high() {
5100         //BOLT 2 Requirement: MUST set cltv_expiry less than 500000000.
5101         //It is enforced when constructing a route.
5102         let mut nodes = create_network(2, &[None, None]);
5103         let _chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 0, LocalFeatures::new(), LocalFeatures::new());
5104         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000000, 500000001).unwrap();
5105         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5106
5107         let err = nodes[0].node.send_payment(route, our_payment_hash);
5108
5109         if let Err(APIError::RouteError{err}) = err {
5110                 assert_eq!(err, "Channel CLTV overflowed?!");
5111         } else {
5112                 assert!(false);
5113         }
5114 }
5115
5116 #[test]
5117 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_num_and_htlc_id_increment() {
5118         //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.
5119         //BOLT 2 Requirement: for the first HTLC it offers MUST set id to 0.
5120         //BOLT 2 Requirement: MUST increase the value of id by 1 for each successive offer.
5121         let mut nodes = create_network(2, &[None, None]);
5122         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 0, LocalFeatures::new(), LocalFeatures::new());
5123         let max_accepted_htlcs = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().their_max_accepted_htlcs as u64;
5124
5125         for i in 0..max_accepted_htlcs {
5126                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5127                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5128                 let payment_event = {
5129                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5130                         check_added_monitors!(nodes[0], 1);
5131
5132                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5133                         assert_eq!(events.len(), 1);
5134                         if let MessageSendEvent::UpdateHTLCs { node_id: _, updates: msgs::CommitmentUpdate{ update_add_htlcs: ref htlcs, .. }, } = events[0] {
5135                                 assert_eq!(htlcs[0].htlc_id, i);
5136                         } else {
5137                                 assert!(false);
5138                         }
5139                         SendEvent::from_event(events.remove(0))
5140                 };
5141                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5142                 check_added_monitors!(nodes[1], 0);
5143                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5144
5145                 expect_pending_htlcs_forwardable!(nodes[1]);
5146                 expect_payment_received!(nodes[1], our_payment_hash, 100000);
5147         }
5148         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
5149         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5150         let err = nodes[0].node.send_payment(route, our_payment_hash);
5151
5152         if let Err(APIError::ChannelUnavailable{err}) = err {
5153                 assert_eq!(err, "Cannot push more than their max accepted HTLCs");
5154         } else {
5155                 assert!(false);
5156         }
5157 }
5158
5159 #[test]
5160 fn test_update_add_htlc_bolt2_sender_exceed_max_htlc_value_in_flight() {
5161         //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.
5162         let mut nodes = create_network(2, &[None, None]);
5163         let channel_value = 100000;
5164         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 0, LocalFeatures::new(), LocalFeatures::new());
5165         let max_in_flight = get_channel_value_stat!(nodes[0], chan.2).their_max_htlc_value_in_flight_msat;
5166
5167         send_payment(&nodes[0], &vec!(&nodes[1])[..], max_in_flight, max_in_flight);
5168
5169         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], max_in_flight+1, TEST_FINAL_CLTV).unwrap();
5170         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5171         let err = nodes[0].node.send_payment(route, our_payment_hash);
5172
5173         if let Err(APIError::ChannelUnavailable{err}) = err {
5174                 assert_eq!(err, "Cannot send value that would put us over the max HTLC value in flight our peer will accept");
5175         } else {
5176                 assert!(false);
5177         }
5178
5179         send_payment(&nodes[0], &[&nodes[1]], max_in_flight, max_in_flight);
5180 }
5181
5182 // BOLT 2 Requirements for the Receiver when handling an update_add_htlc message.
5183 #[test]
5184 fn test_update_add_htlc_bolt2_receiver_check_amount_received_more_than_min() {
5185         //BOLT2 Requirement: receiving an amount_msat equal to 0, OR less than its own htlc_minimum_msat -> SHOULD fail the channel.
5186         let mut nodes = create_network(2, &[None, None]);
5187         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, LocalFeatures::new(), LocalFeatures::new());
5188         let htlc_minimum_msat: u64;
5189         {
5190                 let chan_lock = nodes[0].node.channel_state.lock().unwrap();
5191                 let channel = chan_lock.by_id.get(&chan.2).unwrap();
5192                 htlc_minimum_msat = channel.get_our_htlc_minimum_msat();
5193         }
5194         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], htlc_minimum_msat, TEST_FINAL_CLTV).unwrap();
5195         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5196         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5197         check_added_monitors!(nodes[0], 1);
5198         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5199         updates.update_add_htlcs[0].amount_msat = htlc_minimum_msat-1;
5200         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5201         if let Err(msgs::LightningError{err, action: msgs::ErrorAction::SendErrorMessage {..}}) = err {
5202                 assert_eq!(err, "Remote side tried to send less than our minimum HTLC value");
5203         } else {
5204                 assert!(false);
5205         }
5206         assert!(nodes[1].node.list_channels().is_empty());
5207         check_closed_broadcast!(nodes[1]);
5208 }
5209
5210 #[test]
5211 fn test_update_add_htlc_bolt2_receiver_sender_can_afford_amount_sent() {
5212         //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
5213         let mut nodes = create_network(2, &[None, None]);
5214         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, LocalFeatures::new(), LocalFeatures::new());
5215
5216         let their_channel_reserve = get_channel_value_stat!(nodes[0], chan.2).channel_reserve_msat;
5217
5218         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 5000000-their_channel_reserve, TEST_FINAL_CLTV).unwrap();
5219         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5220         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5221         check_added_monitors!(nodes[0], 1);
5222         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5223
5224         updates.update_add_htlcs[0].amount_msat = 5000000-their_channel_reserve+1;
5225         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5226
5227         if let Err(msgs::LightningError{err, action: msgs::ErrorAction::SendErrorMessage {..}}) = err {
5228                 assert_eq!(err, "Remote HTLC add would put them over their reserve value");
5229         } else {
5230                 assert!(false);
5231         }
5232
5233         assert!(nodes[1].node.list_channels().is_empty());
5234         check_closed_broadcast!(nodes[1]);
5235 }
5236
5237 #[test]
5238 fn test_update_add_htlc_bolt2_receiver_check_max_htlc_limit() {
5239         //BOLT 2 Requirement: if a sending node adds more than its max_accepted_htlcs HTLCs to its local commitment transaction: SHOULD fail the channel
5240         //BOLT 2 Requirement: MUST allow multiple HTLCs with the same payment_hash.
5241         let mut nodes = create_network(2, &[None, None]);
5242         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, LocalFeatures::new(), LocalFeatures::new());
5243         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5244         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5245
5246         let session_priv = SecretKey::from_slice(&{
5247                 let mut session_key = [0; 32];
5248                 let mut rng = thread_rng();
5249                 rng.fill_bytes(&mut session_key);
5250                 session_key
5251         }).expect("RNG is bad!");
5252
5253         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5254         let onion_keys = onion_utils::construct_onion_keys(&Secp256k1::signing_only(), &route, &session_priv).unwrap();
5255         let (onion_payloads, _htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height).unwrap();
5256         let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
5257
5258         let mut msg = msgs::UpdateAddHTLC {
5259                 channel_id: chan.2,
5260                 htlc_id: 0,
5261                 amount_msat: 1000,
5262                 payment_hash: our_payment_hash,
5263                 cltv_expiry: htlc_cltv,
5264                 onion_routing_packet: onion_packet.clone(),
5265         };
5266
5267         for i in 0..super::channel::OUR_MAX_HTLCS {
5268                 msg.htlc_id = i as u64;
5269                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).unwrap();
5270         }
5271         msg.htlc_id = (super::channel::OUR_MAX_HTLCS) as u64;
5272         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg);
5273
5274         if let Err(msgs::LightningError{err, action: msgs::ErrorAction::SendErrorMessage {..}}) = err {
5275                 assert_eq!(err, "Remote tried to push more than our max accepted HTLCs");
5276         } else {
5277                 assert!(false);
5278         }
5279
5280         assert!(nodes[1].node.list_channels().is_empty());
5281         check_closed_broadcast!(nodes[1]);
5282 }
5283
5284 #[test]
5285 fn test_update_add_htlc_bolt2_receiver_check_max_in_flight_msat() {
5286         //OR adds more than its max_htlc_value_in_flight_msat worth of offered HTLCs to its local commitment transaction: SHOULD fail the channel
5287         let mut nodes = create_network(2, &[None, None]);
5288         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, LocalFeatures::new(), LocalFeatures::new());
5289         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5290         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5291         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5292         check_added_monitors!(nodes[0], 1);
5293         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5294         updates.update_add_htlcs[0].amount_msat = get_channel_value_stat!(nodes[1], chan.2).their_max_htlc_value_in_flight_msat + 1;
5295         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5296
5297         if let Err(msgs::LightningError{err, action: msgs::ErrorAction::SendErrorMessage {..}}) = err {
5298                 assert_eq!(err,"Remote HTLC add would put them over our max HTLC value");
5299         } else {
5300                 assert!(false);
5301         }
5302
5303         assert!(nodes[1].node.list_channels().is_empty());
5304         check_closed_broadcast!(nodes[1]);
5305 }
5306
5307 #[test]
5308 fn test_update_add_htlc_bolt2_receiver_check_cltv_expiry() {
5309         //BOLT2 Requirement: if sending node sets cltv_expiry to greater or equal to 500000000: SHOULD fail the channel.
5310         let mut nodes = create_network(2, &[None, None]);
5311         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 95000000, LocalFeatures::new(), LocalFeatures::new());
5312         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 3999999, TEST_FINAL_CLTV).unwrap();
5313         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5314         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5315         check_added_monitors!(nodes[0], 1);
5316         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5317         updates.update_add_htlcs[0].cltv_expiry = 500000000;
5318         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5319
5320         if let Err(msgs::LightningError{err, action: msgs::ErrorAction::SendErrorMessage {..}}) = err {
5321                 assert_eq!(err,"Remote provided CLTV expiry in seconds instead of block height");
5322         } else {
5323                 assert!(false);
5324         }
5325
5326         assert!(nodes[1].node.list_channels().is_empty());
5327         check_closed_broadcast!(nodes[1]);
5328 }
5329
5330 #[test]
5331 fn test_update_add_htlc_bolt2_receiver_check_repeated_id_ignore() {
5332         //BOLT 2 requirement: if the sender did not previously acknowledge the commitment of that HTLC: MUST ignore a repeated id value after a reconnection.
5333         // We test this by first testing that that repeated HTLCs pass commitment signature checks
5334         // after disconnect and that non-sequential htlc_ids result in a channel failure.
5335         let mut nodes = create_network(2, &[None, None]);
5336         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
5337         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5338         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5339         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5340         check_added_monitors!(nodes[0], 1);
5341         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5342         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5343
5344         //Disconnect and Reconnect
5345         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5346         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5347         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5348         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
5349         assert_eq!(reestablish_1.len(), 1);
5350         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5351         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
5352         assert_eq!(reestablish_2.len(), 1);
5353         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
5354         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
5355         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
5356         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
5357
5358         //Resend HTLC
5359         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5360         assert_eq!(updates.commitment_signed.htlc_signatures.len(), 1);
5361         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
5362         check_added_monitors!(nodes[1], 1);
5363         let _bs_responses = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5364
5365         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]);
5366         if let Err(msgs::LightningError{err, action: msgs::ErrorAction::SendErrorMessage {..}}) = err {
5367                 assert_eq!(err, "Remote skipped HTLC ID");
5368         } else {
5369                 assert!(false);
5370         }
5371
5372         assert!(nodes[1].node.list_channels().is_empty());
5373         check_closed_broadcast!(nodes[1]);
5374 }
5375
5376 #[test]
5377 fn test_update_fulfill_htlc_bolt2_update_fulfill_htlc_before_commitment() {
5378         //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.
5379
5380         let mut nodes = create_network(2, &[None, None]);
5381         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
5382
5383         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5384         let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5385         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5386         check_added_monitors!(nodes[0], 1);
5387         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5388         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5389
5390         let update_msg = msgs::UpdateFulfillHTLC{
5391                 channel_id: chan.2,
5392                 htlc_id: 0,
5393                 payment_preimage: our_payment_preimage,
5394         };
5395
5396         let err = nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5397
5398         if let Err(msgs::LightningError{err, action: msgs::ErrorAction::SendErrorMessage {..}}) = err {
5399                 assert_eq!(err, "Remote tried to fulfill/fail HTLC before it had been committed");
5400         } else {
5401                 assert!(false);
5402         }
5403
5404         assert!(nodes[0].node.list_channels().is_empty());
5405         check_closed_broadcast!(nodes[0]);
5406 }
5407
5408 #[test]
5409 fn test_update_fulfill_htlc_bolt2_update_fail_htlc_before_commitment() {
5410         //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.
5411
5412         let mut nodes = create_network(2, &[None, None]);
5413         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
5414
5415         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5416         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5417         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5418         check_added_monitors!(nodes[0], 1);
5419         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5420         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5421
5422         let update_msg = msgs::UpdateFailHTLC{
5423                 channel_id: chan.2,
5424                 htlc_id: 0,
5425                 reason: msgs::OnionErrorPacket { data: Vec::new()},
5426         };
5427
5428         let err = nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5429
5430         if let Err(msgs::LightningError{err, action: msgs::ErrorAction::SendErrorMessage {..}}) = err {
5431                 assert_eq!(err, "Remote tried to fulfill/fail HTLC before it had been committed");
5432         } else {
5433                 assert!(false);
5434         }
5435
5436         assert!(nodes[0].node.list_channels().is_empty());
5437         check_closed_broadcast!(nodes[0]);
5438 }
5439
5440 #[test]
5441 fn test_update_fulfill_htlc_bolt2_update_fail_malformed_htlc_before_commitment() {
5442         //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.
5443
5444         let mut nodes = create_network(2, &[None, None]);
5445         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
5446
5447         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5448         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5449         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5450         check_added_monitors!(nodes[0], 1);
5451         let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5452         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5453
5454         let update_msg = msgs::UpdateFailMalformedHTLC{
5455                 channel_id: chan.2,
5456                 htlc_id: 0,
5457                 sha256_of_onion: [1; 32],
5458                 failure_code: 0x8000,
5459         };
5460
5461         let err = nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5462
5463         if let Err(msgs::LightningError{err, action: msgs::ErrorAction::SendErrorMessage {..}}) = err {
5464                 assert_eq!(err, "Remote tried to fulfill/fail HTLC before it had been committed");
5465         } else {
5466                 assert!(false);
5467         }
5468
5469         assert!(nodes[0].node.list_channels().is_empty());
5470         check_closed_broadcast!(nodes[0]);
5471 }
5472
5473 #[test]
5474 fn test_update_fulfill_htlc_bolt2_incorrect_htlc_id() {
5475         //BOLT 2 Requirement: A receiving node: if the id does not correspond to an HTLC in its current commitment transaction MUST fail the channel.
5476
5477         let nodes = create_network(2, &[None, None]);
5478         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
5479
5480         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5481
5482         nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5483         check_added_monitors!(nodes[1], 1);
5484
5485         let events = nodes[1].node.get_and_clear_pending_msg_events();
5486         assert_eq!(events.len(), 1);
5487         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5488                 match events[0] {
5489                         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, .. } } => {
5490                                 assert!(update_add_htlcs.is_empty());
5491                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5492                                 assert!(update_fail_htlcs.is_empty());
5493                                 assert!(update_fail_malformed_htlcs.is_empty());
5494                                 assert!(update_fee.is_none());
5495                                 update_fulfill_htlcs[0].clone()
5496                         },
5497                         _ => panic!("Unexpected event"),
5498                 }
5499         };
5500
5501         update_fulfill_msg.htlc_id = 1;
5502
5503         let err = nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5504         if let Err(msgs::LightningError{err, action: msgs::ErrorAction::SendErrorMessage {..}}) = err {
5505                 assert_eq!(err, "Remote tried to fulfill/fail an HTLC we couldn't find");
5506         } else {
5507                 assert!(false);
5508         }
5509
5510         assert!(nodes[0].node.list_channels().is_empty());
5511         check_closed_broadcast!(nodes[0]);
5512 }
5513
5514 #[test]
5515 fn test_update_fulfill_htlc_bolt2_wrong_preimage() {
5516         //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.
5517
5518         let nodes = create_network(2, &[None, None]);
5519         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
5520
5521         let our_payment_preimage = route_payment(&nodes[0], &[&nodes[1]], 100000).0;
5522
5523         nodes[1].node.claim_funds(our_payment_preimage, 100_000);
5524         check_added_monitors!(nodes[1], 1);
5525
5526         let events = nodes[1].node.get_and_clear_pending_msg_events();
5527         assert_eq!(events.len(), 1);
5528         let mut update_fulfill_msg: msgs::UpdateFulfillHTLC = {
5529                 match events[0] {
5530                         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, .. } } => {
5531                                 assert!(update_add_htlcs.is_empty());
5532                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5533                                 assert!(update_fail_htlcs.is_empty());
5534                                 assert!(update_fail_malformed_htlcs.is_empty());
5535                                 assert!(update_fee.is_none());
5536                                 update_fulfill_htlcs[0].clone()
5537                         },
5538                         _ => panic!("Unexpected event"),
5539                 }
5540         };
5541
5542         update_fulfill_msg.payment_preimage = PaymentPreimage([1; 32]);
5543
5544         let err = nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_msg);
5545         if let Err(msgs::LightningError{err, action: msgs::ErrorAction::SendErrorMessage {..}}) = err {
5546                 assert_eq!(err, "Remote tried to fulfill HTLC with an incorrect preimage");
5547         } else {
5548                 assert!(false);
5549         }
5550
5551         assert!(nodes[0].node.list_channels().is_empty());
5552         check_closed_broadcast!(nodes[0]);
5553 }
5554
5555
5556 #[test]
5557 fn test_update_fulfill_htlc_bolt2_missing_badonion_bit_for_malformed_htlc_message() {
5558         //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.
5559
5560         let mut nodes = create_network(2, &[None, None]);
5561         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, LocalFeatures::new(), LocalFeatures::new());
5562         let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 1000000, TEST_FINAL_CLTV).unwrap();
5563         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5564         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5565         check_added_monitors!(nodes[0], 1);
5566
5567         let mut updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5568         updates.update_add_htlcs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5569
5570         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
5571         check_added_monitors!(nodes[1], 0);
5572         commitment_signed_dance!(nodes[1], nodes[0], updates.commitment_signed, false, true);
5573
5574         let events = nodes[1].node.get_and_clear_pending_msg_events();
5575
5576         let mut update_msg: msgs::UpdateFailMalformedHTLC = {
5577                 match events[0] {
5578                         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, .. } } => {
5579                                 assert!(update_add_htlcs.is_empty());
5580                                 assert!(update_fulfill_htlcs.is_empty());
5581                                 assert!(update_fail_htlcs.is_empty());
5582                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5583                                 assert!(update_fee.is_none());
5584                                 update_fail_malformed_htlcs[0].clone()
5585                         },
5586                         _ => panic!("Unexpected event"),
5587                 }
5588         };
5589         update_msg.failure_code &= !0x8000;
5590         let err = nodes[0].node.handle_update_fail_malformed_htlc(&nodes[1].node.get_our_node_id(), &update_msg);
5591         if let Err(msgs::LightningError{err, action: msgs::ErrorAction::SendErrorMessage {..}}) = err {
5592                 assert_eq!(err, "Got update_fail_malformed_htlc with BADONION not set");
5593         } else {
5594                 assert!(false);
5595         }
5596
5597         assert!(nodes[0].node.list_channels().is_empty());
5598         check_closed_broadcast!(nodes[0]);
5599 }
5600
5601 #[test]
5602 fn test_update_fulfill_htlc_bolt2_after_malformed_htlc_message_must_forward_update_fail_htlc() {
5603         //BOLT 2 Requirement: a receiving node which has an outgoing HTLC canceled by update_fail_malformed_htlc:
5604         //    * 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.
5605
5606         let mut nodes = create_network(3, &[None, None, None]);
5607         create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, LocalFeatures::new(), LocalFeatures::new());
5608         create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1000000, 1000000, LocalFeatures::new(), LocalFeatures::new());
5609
5610         let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 100000, TEST_FINAL_CLTV).unwrap();
5611         let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5612
5613         //First hop
5614         let mut payment_event = {
5615                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5616                 check_added_monitors!(nodes[0], 1);
5617                 let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5618                 assert_eq!(events.len(), 1);
5619                 SendEvent::from_event(events.remove(0))
5620         };
5621         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5622         check_added_monitors!(nodes[1], 0);
5623         commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5624         expect_pending_htlcs_forwardable!(nodes[1]);
5625         let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5626         assert_eq!(events_2.len(), 1);
5627         check_added_monitors!(nodes[1], 1);
5628         payment_event = SendEvent::from_event(events_2.remove(0));
5629         assert_eq!(payment_event.msgs.len(), 1);
5630
5631         //Second Hop
5632         payment_event.msgs[0].onion_routing_packet.version = 1; //Produce a malformed HTLC message
5633         nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5634         check_added_monitors!(nodes[2], 0);
5635         commitment_signed_dance!(nodes[2], nodes[1], payment_event.commitment_msg, false, true);
5636
5637         let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5638         assert_eq!(events_3.len(), 1);
5639         let update_msg : (msgs::UpdateFailMalformedHTLC, msgs::CommitmentSigned) = {
5640                 match events_3[0] {
5641                         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 } } => {
5642                                 assert!(update_add_htlcs.is_empty());
5643                                 assert!(update_fulfill_htlcs.is_empty());
5644                                 assert!(update_fail_htlcs.is_empty());
5645                                 assert_eq!(update_fail_malformed_htlcs.len(), 1);
5646                                 assert!(update_fee.is_none());
5647                                 (update_fail_malformed_htlcs[0].clone(), commitment_signed.clone())
5648                         },
5649                         _ => panic!("Unexpected event"),
5650                 }
5651         };
5652
5653         nodes[1].node.handle_update_fail_malformed_htlc(&nodes[2].node.get_our_node_id(), &update_msg.0).unwrap();
5654
5655         check_added_monitors!(nodes[1], 0);
5656         commitment_signed_dance!(nodes[1], nodes[2], update_msg.1, false, true);
5657         expect_pending_htlcs_forwardable!(nodes[1]);
5658         let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5659         assert_eq!(events_4.len(), 1);
5660
5661         //Confirm that handlinge the update_malformed_htlc message produces an update_fail_htlc message to be forwarded back along the route
5662         match events_4[0] {
5663                 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, .. } } => {
5664                         assert!(update_add_htlcs.is_empty());
5665                         assert!(update_fulfill_htlcs.is_empty());
5666                         assert_eq!(update_fail_htlcs.len(), 1);
5667                         assert!(update_fail_malformed_htlcs.is_empty());
5668                         assert!(update_fee.is_none());
5669                 },
5670                 _ => panic!("Unexpected event"),
5671         };
5672
5673         check_added_monitors!(nodes[1], 1);
5674 }
5675
5676 fn do_test_failure_delay_dust_htlc_local_commitment(announce_latest: bool) {
5677         // Dust-HTLC failure updates must be delayed until failure-trigger tx (in this case local commitment) reach ANTI_REORG_DELAY
5678         // 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
5679         // HTLC could have been removed from lastest local commitment tx but still valid until we get remote RAA
5680
5681         let nodes = create_network(2, &[None, None]);
5682         let chan =create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
5683
5684         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5685
5686         // We route 2 dust-HTLCs between A and B
5687         let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5688         let (_, payment_hash_2) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5689         route_payment(&nodes[0], &[&nodes[1]], 1000000);
5690
5691         // Cache one local commitment tx as previous
5692         let as_prev_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
5693
5694         // Fail one HTLC to prune it in the will-be-latest-local commitment tx
5695         assert!(nodes[1].node.fail_htlc_backwards(&payment_hash_2));
5696         check_added_monitors!(nodes[1], 0);
5697         expect_pending_htlcs_forwardable!(nodes[1]);
5698         check_added_monitors!(nodes[1], 1);
5699
5700         let remove = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5701         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &remove.update_fail_htlcs[0]).unwrap();
5702         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &remove.commitment_signed).unwrap();
5703         check_added_monitors!(nodes[0], 1);
5704
5705         // Cache one local commitment tx as lastest
5706         let as_last_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
5707
5708         let events = nodes[0].node.get_and_clear_pending_msg_events();
5709         match events[0] {
5710                 MessageSendEvent::SendRevokeAndACK { node_id, .. } => {
5711                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
5712                 },
5713                 _ => panic!("Unexpected event"),
5714         }
5715         match events[1] {
5716                 MessageSendEvent::UpdateHTLCs { node_id, .. } => {
5717                         assert_eq!(node_id, nodes[1].node.get_our_node_id());
5718                 },
5719                 _ => panic!("Unexpected event"),
5720         }
5721
5722         assert_ne!(as_prev_commitment_tx, as_last_commitment_tx);
5723         // Fail the 2 dust-HTLCs, move their failure in maturation buffer (htlc_updated_waiting_threshold_conf)
5724         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5725
5726         if announce_latest {
5727                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_last_commitment_tx[0].clone()]}, 1);
5728         } else {
5729                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_prev_commitment_tx[0].clone()]}, 1);
5730         }
5731
5732         let events = nodes[0].node.get_and_clear_pending_msg_events();
5733         assert_eq!(events.len(), 1);
5734         match events[0] {
5735                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5736                 _ => panic!("Unexpected event"),
5737         }
5738
5739         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5740         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 1, true,  header.bitcoin_hash());
5741         let events = nodes[0].node.get_and_clear_pending_events();
5742         // Only 2 PaymentFailed events should show up, over-dust HTLC has to be failed by timeout tx
5743         assert_eq!(events.len(), 2);
5744         let mut first_failed = false;
5745         for event in events {
5746                 match event {
5747                         Event::PaymentFailed { payment_hash, .. } => {
5748                                 if payment_hash == payment_hash_1 {
5749                                         assert!(!first_failed);
5750                                         first_failed = true;
5751                                 } else {
5752                                         assert_eq!(payment_hash, payment_hash_2);
5753                                 }
5754                         }
5755                         _ => panic!("Unexpected event"),
5756                 }
5757         }
5758 }
5759
5760 #[test]
5761 fn test_failure_delay_dust_htlc_local_commitment() {
5762         do_test_failure_delay_dust_htlc_local_commitment(true);
5763         do_test_failure_delay_dust_htlc_local_commitment(false);
5764 }
5765
5766 #[test]
5767 fn test_no_failure_dust_htlc_local_commitment() {
5768         // Transaction filters for failing back dust htlc based on local commitment txn infos has been
5769         // prone to error, we test here that a dummy transaction don't fail them.
5770
5771         let nodes = create_network(2, &[None, None]);
5772         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
5773
5774         // Rebalance a bit
5775         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
5776
5777         let as_dust_limit = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5778         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5779
5780         // We route 2 dust-HTLCs between A and B
5781         let (preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5782         let (preimage_2, _) = route_payment(&nodes[1], &[&nodes[0]], as_dust_limit*1000);
5783
5784         // Build a dummy invalid transaction trying to spend a commitment tx
5785         let input = TxIn {
5786                 previous_output: BitcoinOutPoint { txid: chan.3.txid(), vout: 0 },
5787                 script_sig: Script::new(),
5788                 sequence: 0,
5789                 witness: Vec::new(),
5790         };
5791
5792         let outp = TxOut {
5793                 script_pubkey: Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script(),
5794                 value: 10000,
5795         };
5796
5797         let dummy_tx = Transaction {
5798                 version: 2,
5799                 lock_time: 0,
5800                 input: vec![input],
5801                 output: vec![outp]
5802         };
5803
5804         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5805         nodes[0].chan_monitor.simple_monitor.block_connected(&header, 1, &[&dummy_tx], &[1;1]);
5806         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5807         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
5808         // We broadcast a few more block to check everything is all right
5809         connect_blocks(&nodes[0].block_notifier, 20, 1, true,  header.bitcoin_hash());
5810         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5811         assert_eq!(nodes[0].node.get_and_clear_pending_msg_events().len(), 0);
5812
5813         claim_payment(&nodes[0], &vec!(&nodes[1])[..], preimage_1, bs_dust_limit*1000);
5814         claim_payment(&nodes[1], &vec!(&nodes[0])[..], preimage_2, as_dust_limit*1000);
5815 }
5816
5817 fn do_test_sweep_outbound_htlc_failure_update(revoked: bool, local: bool) {
5818         // Outbound HTLC-failure updates must be cancelled if we get a reorg before we reach ANTI_REORG_DELAY.
5819         // Broadcast of revoked remote commitment tx, trigger failure-update of dust/non-dust HTLCs
5820         // Broadcast of remote commitment tx, trigger failure-update of dust-HTLCs
5821         // Broadcast of timeout tx on remote commitment tx, trigger failure-udate of non-dust HTLCs
5822         // Broadcast of local commitment tx, trigger failure-update of dust-HTLCs
5823         // Broadcast of HTLC-timeout tx on local commitment tx, trigger failure-update of non-dust HTLCs
5824
5825         let nodes = create_network(3, &[None, None, None]);
5826         let chan = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
5827
5828         let bs_dust_limit = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().our_dust_limit_satoshis;
5829
5830         let (_payment_preimage_1, dust_hash) = route_payment(&nodes[0], &[&nodes[1]], bs_dust_limit*1000);
5831         let (_payment_preimage_2, non_dust_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
5832
5833         let as_commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
5834         let bs_commitment_tx = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
5835
5836         // We revoked bs_commitment_tx
5837         if revoked {
5838                 let (payment_preimage_3, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
5839                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3, 1_000_000);
5840         }
5841
5842         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5843         let mut timeout_tx = Vec::new();
5844         if local {
5845                 // We fail dust-HTLC 1 by broadcast of local commitment tx
5846                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![as_commitment_tx[0].clone()]}, 1);
5847                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5848                 assert_eq!(events.len(), 1);
5849                 match events[0] {
5850                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5851                         _ => panic!("Unexpected event"),
5852                 }
5853                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5854                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
5855                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
5856                 let events = nodes[0].node.get_and_clear_pending_events();
5857                 assert_eq!(events.len(), 1);
5858                 match events[0] {
5859                         Event::PaymentFailed { payment_hash, .. } => {
5860                                 assert_eq!(payment_hash, dust_hash);
5861                         },
5862                         _ => panic!("Unexpected event"),
5863                 }
5864                 assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), OFFERED_HTLC_SCRIPT_WEIGHT);
5865                 // We fail non-dust-HTLC 2 by broadcast of local HTLC-timeout tx on local commitment tx
5866                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5867                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5868                 nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
5869                 let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5870                 connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
5871                 let events = nodes[0].node.get_and_clear_pending_events();
5872                 assert_eq!(events.len(), 1);
5873                 match events[0] {
5874                         Event::PaymentFailed { payment_hash, .. } => {
5875                                 assert_eq!(payment_hash, non_dust_hash);
5876                         },
5877                         _ => panic!("Unexpected event"),
5878                 }
5879         } else {
5880                 // We fail dust-HTLC 1 by broadcast of remote commitment tx. If revoked, fail also non-dust HTLC
5881                 nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![bs_commitment_tx[0].clone()]}, 1);
5882                 assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5883                 let events = nodes[0].node.get_and_clear_pending_msg_events();
5884                 assert_eq!(events.len(), 1);
5885                 match events[0] {
5886                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5887                         _ => panic!("Unexpected event"),
5888                 }
5889                 timeout_tx.push(nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap()[0].clone());
5890                 let parent_hash  = connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 2, true, header.bitcoin_hash());
5891                 let header_2 = BlockHeader { version: 0x20000000, prev_blockhash: parent_hash, merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5892                 if !revoked {
5893                         let events = nodes[0].node.get_and_clear_pending_events();
5894                         assert_eq!(events.len(), 1);
5895                         match events[0] {
5896                                 Event::PaymentFailed { payment_hash, .. } => {
5897                                         assert_eq!(payment_hash, dust_hash);
5898                                 },
5899                                 _ => panic!("Unexpected event"),
5900                         }
5901                         assert_eq!(timeout_tx[0].input[0].witness.last().unwrap().len(), ACCEPTED_HTLC_SCRIPT_WEIGHT);
5902                         // We fail non-dust-HTLC 2 by broadcast of local timeout tx on remote commitment tx
5903                         nodes[0].block_notifier.block_connected(&Block { header: header_2, txdata: vec![timeout_tx[0].clone()]}, 7);
5904                         assert_eq!(nodes[0].node.get_and_clear_pending_events().len(), 0);
5905                         let header_3 = BlockHeader { version: 0x20000000, prev_blockhash: header_2.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5906                         connect_blocks(&nodes[0].block_notifier, ANTI_REORG_DELAY - 1, 8, true, header_3.bitcoin_hash());
5907                         let events = nodes[0].node.get_and_clear_pending_events();
5908                         assert_eq!(events.len(), 1);
5909                         match events[0] {
5910                                 Event::PaymentFailed { payment_hash, .. } => {
5911                                         assert_eq!(payment_hash, non_dust_hash);
5912                                 },
5913                                 _ => panic!("Unexpected event"),
5914                         }
5915                 } else {
5916                         // If revoked, both dust & non-dust HTLCs should have been failed after ANTI_REORG_DELAY confs of revoked
5917                         // commitment tx
5918                         let events = nodes[0].node.get_and_clear_pending_events();
5919                         assert_eq!(events.len(), 2);
5920                         let first;
5921                         match events[0] {
5922                                 Event::PaymentFailed { payment_hash, .. } => {
5923                                         if payment_hash == dust_hash { first = true; }
5924                                         else { first = false; }
5925                                 },
5926                                 _ => panic!("Unexpected event"),
5927                         }
5928                         match events[1] {
5929                                 Event::PaymentFailed { payment_hash, .. } => {
5930                                         if first { assert_eq!(payment_hash, non_dust_hash); }
5931                                         else { assert_eq!(payment_hash, dust_hash); }
5932                                 },
5933                                 _ => panic!("Unexpected event"),
5934                         }
5935                 }
5936         }
5937 }
5938
5939 #[test]
5940 fn test_sweep_outbound_htlc_failure_update() {
5941         do_test_sweep_outbound_htlc_failure_update(false, true);
5942         do_test_sweep_outbound_htlc_failure_update(false, false);
5943         do_test_sweep_outbound_htlc_failure_update(true, false);
5944 }
5945
5946 #[test]
5947 fn test_upfront_shutdown_script() {
5948         // BOLT 2 : Option upfront shutdown script, if peer commit its closing_script at channel opening
5949         // enforce it at shutdown message
5950
5951         let mut config = UserConfig::new();
5952         config.channel_options.announced_channel = true;
5953         config.peer_channel_config_limits.force_announced_channel_preference = false;
5954         config.channel_options.commit_upfront_shutdown_pubkey = false;
5955         let cfgs = [None, Some(config), None];
5956         let nodes = create_network(3, &cfgs);
5957
5958         // We test that in case of peer committing upfront to a script, if it changes at closing, we refuse to sign
5959         let flags = LocalFeatures::new();
5960         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
5961         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
5962         let mut node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
5963         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
5964         // Test we enforce upfront_scriptpbukey if by providing a diffrent one at closing that  we disconnect peer
5965         if let Err(error) = nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown) {
5966                 match error.action {
5967                         ErrorAction::SendErrorMessage { msg } => {
5968                                 assert_eq!(msg.data,"Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey");
5969                         },
5970                         _ => { assert!(false); }
5971                 }
5972         } else { assert!(false); }
5973         let events = nodes[2].node.get_and_clear_pending_msg_events();
5974         assert_eq!(events.len(), 1);
5975         match events[0] {
5976                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5977                 _ => panic!("Unexpected event"),
5978         }
5979
5980         // We test that in case of peer committing upfront to a script, if it doesn't change at closing, we sign
5981         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 2, 1000000, 1000000, flags.clone(), flags.clone());
5982         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
5983         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[2].node.get_our_node_id());
5984         // We test that in case of peer committing upfront to a script, if it oesn't change at closing, we sign
5985         if let Ok(_) = nodes[2].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown) {}
5986         else { assert!(false) }
5987         let events = nodes[2].node.get_and_clear_pending_msg_events();
5988         assert_eq!(events.len(), 1);
5989         match events[0] {
5990                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
5991                 _ => panic!("Unexpected event"),
5992         }
5993
5994         // We test that if case of peer non-signaling we don't enforce committed script at channel opening
5995         let mut flags_no = LocalFeatures::new();
5996         flags_no.unset_upfront_shutdown_script();
5997         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags_no, flags.clone());
5998         nodes[0].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
5999         let mut node_1_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
6000         node_1_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6001         if let Ok(_) = nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_1_shutdown) {}
6002         else { assert!(false) }
6003         let events = nodes[1].node.get_and_clear_pending_msg_events();
6004         assert_eq!(events.len(), 1);
6005         match events[0] {
6006                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[0].node.get_our_node_id()) }
6007                 _ => panic!("Unexpected event"),
6008         }
6009
6010         // We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6011         // channel smoothly, opt-out is from channel initiator here
6012         let chan = create_announced_chan_between_nodes_with_value(&nodes, 1, 0, 1000000, 1000000, flags.clone(), flags.clone());
6013         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6014         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6015         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6016         if let Ok(_) = nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown) {}
6017         else { assert!(false) }
6018         let events = nodes[0].node.get_and_clear_pending_msg_events();
6019         assert_eq!(events.len(), 1);
6020         match events[0] {
6021                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6022                 _ => panic!("Unexpected event"),
6023         }
6024
6025         //// We test that if user opt-out, we provide a zero-length script at channel opening and we are able to close
6026         //// channel smoothly
6027         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, flags.clone(), flags.clone());
6028         nodes[1].node.close_channel(&OutPoint::new(chan.3.txid(), 0).to_channel_id()).unwrap();
6029         let mut node_0_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
6030         node_0_shutdown.scriptpubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script().to_p2sh();
6031         if let Ok(_) = nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_0_shutdown) {}
6032         else { assert!(false) }
6033         let events = nodes[0].node.get_and_clear_pending_msg_events();
6034         assert_eq!(events.len(), 2);
6035         match events[0] {
6036                 MessageSendEvent::SendShutdown { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6037                 _ => panic!("Unexpected event"),
6038         }
6039         match events[1] {
6040                 MessageSendEvent::SendClosingSigned { node_id, .. } => { assert_eq!(node_id, nodes[1].node.get_our_node_id()) }
6041                 _ => panic!("Unexpected event"),
6042         }
6043 }
6044
6045 #[test]
6046 fn test_user_configurable_csv_delay() {
6047         // We test our channel constructors yield errors when we pass them absurd csv delay
6048
6049         let mut low_our_to_self_config = UserConfig::new();
6050         low_our_to_self_config.own_channel_config.our_to_self_delay = 6;
6051         let mut high_their_to_self_config = UserConfig::new();
6052         high_their_to_self_config.peer_channel_config_limits.their_to_self_delay = 100;
6053         let cfgs = [Some(high_their_to_self_config.clone()), None];
6054         let nodes = create_network(2, &cfgs);
6055
6056         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_outbound()
6057         let keys_manager: Arc<KeysInterface> = Arc::new(KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new()), 10, 20));
6058         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) {
6059                 match error {
6060                         APIError::APIMisuseError { err } => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6061                         _ => panic!("Unexpected event"),
6062                 }
6063         } else { assert!(false) }
6064
6065         // We test config.our_to_self > BREAKDOWN_TIMEOUT is enforced in Channel::new_from_req()
6066         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6067         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6068         open_channel.to_self_delay = 200;
6069         if let Err(error) = Channel::new_from_req(&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), LocalFeatures::new(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &low_our_to_self_config) {
6070                 match error {
6071                         ChannelError::Close(err) => { assert_eq!(err, "Configured with an unreasonable our_to_self_delay putting user funds at risks"); },
6072                         _ => panic!("Unexpected event"),
6073                 }
6074         } else { assert!(false); }
6075
6076         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Chanel::accept_channel()
6077         nodes[0].node.create_channel(nodes[1].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6078         nodes[1].node.handle_open_channel(&nodes[0].node.get_our_node_id(), LocalFeatures::new(), &get_event_msg!(nodes[0], MessageSendEvent::SendOpenChannel, nodes[1].node.get_our_node_id())).unwrap();
6079         let mut accept_channel = get_event_msg!(nodes[1], MessageSendEvent::SendAcceptChannel, nodes[0].node.get_our_node_id());
6080         accept_channel.to_self_delay = 200;
6081         if let Err(error) = nodes[0].node.handle_accept_channel(&nodes[1].node.get_our_node_id(), LocalFeatures::new(), &accept_channel) {
6082                 match error.action {
6083                         ErrorAction::SendErrorMessage { msg } => {
6084                                 assert_eq!(msg.data,"They wanted our payments to be delayed by a needlessly long period");
6085                         },
6086                         _ => { assert!(false); }
6087                 }
6088         } else { assert!(false); }
6089
6090         // We test msg.to_self_delay <= config.their_to_self_delay is enforced in Channel::new_from_req()
6091         nodes[1].node.create_channel(nodes[0].node.get_our_node_id(), 1000000, 1000000, 42).unwrap();
6092         let mut open_channel = get_event_msg!(nodes[1], MessageSendEvent::SendOpenChannel, nodes[0].node.get_our_node_id());
6093         open_channel.to_self_delay = 200;
6094         if let Err(error) = Channel::new_from_req(&test_utils::TestFeeEstimator { sat_per_kw: 253 }, &keys_manager, nodes[1].node.get_our_node_id(), LocalFeatures::new(), &open_channel, 0, Arc::new(test_utils::TestLogger::new()), &high_their_to_self_config) {
6095                 match error {
6096                         ChannelError::Close(err) => { assert_eq!(err, "They wanted our payments to be delayed by a needlessly long period"); },
6097                         _ => panic!("Unexpected event"),
6098                 }
6099         } else { assert!(false); }
6100 }
6101
6102 #[test]
6103 fn test_data_loss_protect() {
6104         // We want to be sure that :
6105         // * we don't broadcast our Local Commitment Tx in case of fallen behind
6106         // * we close channel in case of detecting other being fallen behind
6107         // * we are able to claim our own outputs thanks to remote my_current_per_commitment_point
6108         let mut nodes = create_network(2, &[None, None]);
6109
6110         let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1000000, 1000000, LocalFeatures::new(), LocalFeatures::new());
6111
6112         // Cache node A state before any channel update
6113         let previous_node_state = nodes[0].node.encode();
6114         let mut previous_chan_monitor_state = test_utils::TestVecWriter(Vec::new());
6115         nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut previous_chan_monitor_state).unwrap();
6116
6117         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6118         send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000, 8_000_000);
6119
6120         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6121         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6122
6123         // Restore node A from previous state
6124         let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::with_id(format!("node {}", 0)));
6125         let chan_monitor = <(Sha256dHash, ChannelMonitor)>::read(&mut ::std::io::Cursor::new(previous_chan_monitor_state.0), Arc::clone(&logger)).unwrap().1;
6126         let chain_monitor = Arc::new(ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
6127         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
6128         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
6129         let monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone(), feeest.clone()));
6130         let mut channel_monitors = HashMap::new();
6131         channel_monitors.insert(OutPoint { txid: chan.3.txid(), index: 0 }, &chan_monitor);
6132         let node_state_0 = <(Sha256dHash, ChannelManager)>::read(&mut ::std::io::Cursor::new(previous_node_state), ChannelManagerReadArgs {
6133                 keys_manager: Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::clone(&logger), 42, 21)),
6134                 fee_estimator: feeest.clone(),
6135                 monitor: monitor.clone(),
6136                 logger: Arc::clone(&logger),
6137                 tx_broadcaster,
6138                 default_config: UserConfig::new(),
6139                 channel_monitors: &channel_monitors
6140         }).unwrap().1;
6141         nodes[0].node = Arc::new(node_state_0);
6142         monitor.add_update_monitor(OutPoint { txid: chan.3.txid(), index: 0 }, chan_monitor.clone()).is_ok();
6143         nodes[0].chan_monitor = monitor;
6144         nodes[0].chain_monitor = chain_monitor;
6145
6146         let weak_res = Arc::downgrade(&nodes[0].chan_monitor.simple_monitor);
6147         nodes[0].block_notifier.register_listener(weak_res);
6148         let weak_res = Arc::downgrade(&nodes[0].node);
6149         nodes[0].block_notifier.register_listener(weak_res);
6150
6151         check_added_monitors!(nodes[0], 1);
6152
6153         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
6154         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
6155
6156         let reestablish_0 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6157
6158         // Check we update monitor following learning of per_commitment_point from B
6159         if let Err(err) = nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_0[0])  {
6160                 match err.action {
6161                         ErrorAction::SendErrorMessage { msg } => {
6162                                 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");
6163                         },
6164                         _ => panic!("Unexpected event!"),
6165                 }
6166         } else { assert!(false); }
6167         check_added_monitors!(nodes[0], 1);
6168
6169         {
6170                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6171                 assert_eq!(node_txn.len(), 0);
6172         }
6173
6174         let mut reestablish_1 = Vec::with_capacity(1);
6175         for msg in nodes[0].node.get_and_clear_pending_msg_events() {
6176                 if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6177                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6178                         reestablish_1.push(msg.clone());
6179                 } else if let MessageSendEvent::BroadcastChannelUpdate { .. } = msg {
6180                 } else {
6181                         panic!("Unexpected event")
6182                 }
6183         }
6184
6185         // Check we close channel detecting A is fallen-behind
6186         if let Err(err) = nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]) {
6187                 match err.action {
6188                         ErrorAction::SendErrorMessage { msg } => {
6189                                 assert_eq!(msg.data, "Peer attempted to reestablish channel with a very old local commitment transaction"); },
6190                         _ => panic!("Unexpected event!"),
6191                 }
6192         } else { assert!(false); }
6193
6194         let events = nodes[1].node.get_and_clear_pending_msg_events();
6195         assert_eq!(events.len(), 1);
6196         match events[0] {
6197                 MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6198                 _ => panic!("Unexpected event"),
6199         }
6200
6201         // Check A is able to claim to_remote output
6202         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clone();
6203         assert_eq!(node_txn.len(), 1);
6204         check_spends!(node_txn[0], chan.3.clone());
6205         assert_eq!(node_txn[0].output.len(), 2);
6206         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42};
6207         nodes[0].block_notifier.block_connected(&Block { header, txdata: vec![node_txn[0].clone()]}, 1);
6208         let spend_txn = check_spendable_outputs!(nodes[0], 1);
6209         assert_eq!(spend_txn.len(), 1);
6210         check_spends!(spend_txn[0], node_txn[0].clone());
6211 }
6212
6213 #[test]
6214 fn test_check_htlc_underpaying() {
6215         // Send payment through A -> B but A is maliciously
6216         // sending a probe payment (i.e less than expected value0
6217         // to B, B should refuse payment.
6218
6219         let nodes = create_network(2, &[None, None, None]);
6220
6221         // Create some initial channels
6222         create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new());
6223
6224         let (payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 10_000);
6225
6226         // Node 3 is expecting payment of 100_000 but receive 10_000,
6227         // fail htlc like we didn't know the preimage.
6228         nodes[1].node.claim_funds(payment_preimage, 100_000);
6229         nodes[1].node.process_pending_htlc_forwards();
6230
6231         let events = nodes[1].node.get_and_clear_pending_msg_events();
6232         assert_eq!(events.len(), 1);
6233         let (update_fail_htlc, commitment_signed) = match events[0] {
6234                 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 } } => {
6235                         assert!(update_add_htlcs.is_empty());
6236                         assert!(update_fulfill_htlcs.is_empty());
6237                         assert_eq!(update_fail_htlcs.len(), 1);
6238                         assert!(update_fail_malformed_htlcs.is_empty());
6239                         assert!(update_fee.is_none());
6240                         (update_fail_htlcs[0].clone(), commitment_signed)
6241                 },
6242                 _ => panic!("Unexpected event"),
6243         };
6244         check_added_monitors!(nodes[1], 1);
6245
6246         nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &update_fail_htlc).unwrap();
6247         commitment_signed_dance!(nodes[0], nodes[1], commitment_signed, false, true);
6248
6249         let events = nodes[0].node.get_and_clear_pending_events();
6250         assert_eq!(events.len(), 1);
6251         if let &Event::PaymentFailed { payment_hash:_, ref rejected_by_dest, ref error_code } = &events[0] {
6252                 assert_eq!(*rejected_by_dest, true);
6253                 assert_eq!(error_code.unwrap(), 0x4000|15);
6254         } else {
6255                 panic!("Unexpected event");
6256         }
6257         nodes[1].node.get_and_clear_pending_events();
6258 }
6259
6260 #[test]
6261 fn test_announce_disable_channels() {
6262         // Create 2 channels between A and B. Disconnect B. Call timer_chan_freshness_every_min and check for generated
6263         // ChannelUpdate. Reconnect B, reestablish and check there is non-generated ChannelUpdate.
6264
6265         let nodes = create_network(2, &[None, None]);
6266
6267         let short_id_1 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new()).0.contents.short_channel_id;
6268         let short_id_2 = create_announced_chan_between_nodes(&nodes, 1, 0, LocalFeatures::new(), LocalFeatures::new()).0.contents.short_channel_id;
6269         let short_id_3 = create_announced_chan_between_nodes(&nodes, 0, 1, LocalFeatures::new(), LocalFeatures::new()).0.contents.short_channel_id;
6270
6271         // Disconnect peers
6272         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6273         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6274
6275         nodes[0].node.timer_chan_freshness_every_min(); // dirty -> stagged
6276         nodes[0].node.timer_chan_freshness_every_min(); // staged -> fresh
6277         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6278         assert_eq!(msg_events.len(), 3);
6279         for e in msg_events {
6280                 match e {
6281                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
6282                                 let short_id = msg.contents.short_channel_id;
6283                                 // Check generated channel_update match list in PendingChannelUpdate
6284                                 if short_id != short_id_1 && short_id != short_id_2 && short_id != short_id_3 {
6285                                         panic!("Generated ChannelUpdate for wrong chan!");
6286                                 }
6287                         },
6288                         _ => panic!("Unexpected event"),
6289                 }
6290         }
6291         // Reconnect peers
6292         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
6293         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6294         assert_eq!(reestablish_1.len(), 3);
6295         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
6296         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6297         assert_eq!(reestablish_2.len(), 3);
6298
6299         // Reestablish chan_1
6300         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
6301         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6302         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
6303         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6304         // Reestablish chan_2
6305         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[1]).unwrap();
6306         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6307         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[1]).unwrap();
6308         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6309         // Reestablish chan_3
6310         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[2]).unwrap();
6311         handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6312         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[2]).unwrap();
6313         handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6314
6315         nodes[0].node.timer_chan_freshness_every_min();
6316         let msg_events = nodes[0].node.get_and_clear_pending_msg_events();
6317         assert_eq!(msg_events.len(), 0);
6318 }