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