_ Git - rust-lightning/blob - src/ln/channelmanager.rs

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