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

   1 use bitcoin::blockdata::block::BlockHeader;
   2 use bitcoin::blockdata::transaction::Transaction;
   3 use bitcoin::blockdata::constants::genesis_block;
   4 use bitcoin::network::constants::Network;
   5 use bitcoin::network::serialize::BitcoinHash;
   6 use bitcoin::util::hash::Sha256dHash;
   7
   8 use secp256k1::key::{SecretKey,PublicKey};
   9 use secp256k1::{Secp256k1,Message};
  10 use secp256k1::ecdh::SharedSecret;
  11 use secp256k1;
  12
  13 use chain::chaininterface::{BroadcasterInterface,ChainListener,ChainWatchInterface,FeeEstimator};
  14 use chain::transaction::OutPoint;
  15 use ln::channel::{Channel, ChannelKeys};
  16 use ln::channelmonitor::ManyChannelMonitor;
  17 use ln::router::{Route,RouteHop};
  18 use ln::msgs;
  19 use ln::msgs::{HandleError,ChannelMessageHandler,MsgEncodable,MsgDecodable};
  20 use util::{byte_utils, events, internal_traits, rng};
  21 use util::sha2::Sha256;
  22 use util::chacha20poly1305rfc::ChaCha20;
  23 use util::logger::Logger;
  24 use util::errors::APIError;
  25
  26 use crypto;
  27 use crypto::mac::{Mac,MacResult};
  28 use crypto::hmac::Hmac;
  29 use crypto::digest::Digest;
  30 use crypto::symmetriccipher::SynchronousStreamCipher;
  31
  32 use std::{ptr, mem};
  33 use std::collections::HashMap;
  34 use std::collections::hash_map;
  35 use std::sync::{Mutex,MutexGuard,Arc};
  36 use std::sync::atomic::{AtomicUsize, Ordering};
  37 use std::time::{Instant,Duration};
  38
  39 mod channel_held_info {
  40         use ln::msgs;
  41
  42         /// Stores the info we will need to send when we want to forward an HTLC onwards
  43         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
  44         pub struct PendingForwardHTLCInfo {
  45                 pub(super) onion_packet: Option<msgs::OnionPacket>,
  46                 pub(super) payment_hash: [u8; 32],
  47                 pub(super) short_channel_id: u64,
  48                 pub(super) prev_short_channel_id: u64,
  49                 pub(super) amt_to_forward: u64,
  50                 pub(super) outgoing_cltv_value: u32,
  51         }
  52
  53         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
  54         pub enum HTLCFailureMsg {
  55                 Relay(msgs::UpdateFailHTLC),
  56                 Malformed(msgs::UpdateFailMalformedHTLC),
  57         }
  58
  59         /// Stores whether we can't forward an HTLC or relevant forwarding info
  60         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
  61         pub enum PendingHTLCStatus {
  62                 Forward(PendingForwardHTLCInfo),
  63                 Fail(HTLCFailureMsg),
  64         }
  65
  66         #[cfg(feature = "fuzztarget")]
  67         impl PendingHTLCStatus {
  68                 pub fn dummy() -> Self {
  69                         PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
  70                                 onion_packet: None,
  71                                 payment_hash: [0; 32],
  72                                 short_channel_id: 0,
  73                                 prev_short_channel_id: 0,
  74                                 amt_to_forward: 0,
  75                                 outgoing_cltv_value: 0,
  76                         })
  77                 }
  78         }
  79
  80         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
  81         pub enum HTLCFailReason {
  82                 ErrorPacket {
  83                         err: msgs::OnionErrorPacket,
  84                 },
  85                 Reason {
  86                         failure_code: u16,
  87                         data: Vec<u8>,
  88                 }
  89         }
  90
  91         #[cfg(feature = "fuzztarget")]
  92         impl HTLCFailReason {
  93                 pub fn dummy() -> Self {
  94                         HTLCFailReason::Reason {
  95                                 failure_code: 0, data: Vec::new(),
  96                         }
  97                 }
  98         }
  99 }
 100 #[cfg(feature = "fuzztarget")]
 101 pub use self::channel_held_info::*;
 102 #[cfg(not(feature = "fuzztarget"))]
 103 pub(crate) use self::channel_held_info::*;
 104
 105 enum PendingOutboundHTLC {
 106         IntermediaryHopData {
 107                 source_short_channel_id: u64,
 108                 incoming_packet_shared_secret: SharedSecret,
 109         },
 110         OutboundRoute {
 111                 route: Route,
 112                 session_priv: SecretKey,
 113         },
 114         /// Used for channel rebalancing
 115         CycledRoute {
 116                 source_short_channel_id: u64,
 117                 incoming_packet_shared_secret: SharedSecret,
 118                 route: Route,
 119                 session_priv: SecretKey,
 120         }
 121 }
 122
 123 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
 124 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
 125 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
 126 /// probably increase this significantly.
 127 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
 128
 129 struct ChannelHolder {
 130         by_id: HashMap<[u8; 32], Channel>,
 131         short_to_id: HashMap<u64, [u8; 32]>,
 132         next_forward: Instant,
 133         /// short channel id -> forward infos. Key of 0 means payments received
 134         /// Note that while this is held in the same mutex as the channels themselves, no consistency
 135         /// guarantees are made about there existing a channel with the short id here, nor the short
 136         /// ids in the PendingForwardHTLCInfo!
 137         forward_htlcs: HashMap<u64, Vec<PendingForwardHTLCInfo>>,
 138         /// Note that while this is held in the same mutex as the channels themselves, no consistency
 139         /// guarantees are made about the channels given here actually existing anymore by the time you
 140         /// go to read them!
 141         claimable_htlcs: HashMap<[u8; 32], PendingOutboundHTLC>,
 142 }
 143 struct MutChannelHolder<'a> {
 144         by_id: &'a mut HashMap<[u8; 32], Channel>,
 145         short_to_id: &'a mut HashMap<u64, [u8; 32]>,
 146         next_forward: &'a mut Instant,
 147         forward_htlcs: &'a mut HashMap<u64, Vec<PendingForwardHTLCInfo>>,
 148         claimable_htlcs: &'a mut HashMap<[u8; 32], PendingOutboundHTLC>,
 149 }
 150 impl ChannelHolder {
 151         fn borrow_parts(&mut self) -> MutChannelHolder {
 152                 MutChannelHolder {
 153                         by_id: &mut self.by_id,
 154                         short_to_id: &mut self.short_to_id,
 155                         next_forward: &mut self.next_forward,
 156                         forward_htlcs: &mut self.forward_htlcs,
 157                         claimable_htlcs: &mut self.claimable_htlcs,
 158                 }
 159         }
 160 }
 161
 162 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
 163 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
 164
 165 /// Manager which keeps track of a number of channels and sends messages to the appropriate
 166 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
 167 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
 168 /// to individual Channels.
 169 pub struct ChannelManager {
 170         genesis_hash: Sha256dHash,
 171         fee_estimator: Arc<FeeEstimator>,
 172         monitor: Arc<ManyChannelMonitor>,
 173         chain_monitor: Arc<ChainWatchInterface>,
 174         tx_broadcaster: Arc<BroadcasterInterface>,
 175
 176         announce_channels_publicly: bool,
 177         fee_proportional_millionths: u32,
 178         latest_block_height: AtomicUsize,
 179         secp_ctx: Secp256k1<secp256k1::All>,
 180
 181         channel_state: Mutex<ChannelHolder>,
 182         our_network_key: SecretKey,
 183
 184         pending_events: Mutex<Vec<events::Event>>,
 185
 186         logger: Arc<Logger>,
 187 }
 188
 189 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
 190
 191 macro_rules! secp_call {
 192         ( $res : expr ) => {
 193                 match $res {
 194                         Ok(key) => key,
 195                         //TODO: Make the err a parameter!
 196                         Err(_) => return Err(HandleError{err: "Key error", action: None})
 197                 }
 198         };
 199 }
 200
 201 struct OnionKeys {
 202         #[cfg(test)]
 203         shared_secret: SharedSecret,
 204         #[cfg(test)]
 205         blinding_factor: [u8; 32],
 206         ephemeral_pubkey: PublicKey,
 207         rho: [u8; 32],
 208         mu: [u8; 32],
 209 }
 210
 211 pub struct ChannelDetails {
 212         /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
 213         /// thereafter this is the txid of the funding transaction xor the funding transaction output).
 214         /// Note that this means this value is *not* persistent - it can change once during the
 215         /// lifetime of the channel.
 216         pub channel_id: [u8; 32],
 217         /// The position of the funding transaction in the chain. None if the funding transaction has
 218         /// not yet been confirmed and the channel fully opened.
 219         pub short_channel_id: Option<u64>,
 220         pub remote_network_id: PublicKey,
 221         pub channel_value_satoshis: u64,
 222         /// The user_id passed in to create_channel, or 0 if the channel was inbound.
 223         pub user_id: u64,
 224 }
 225
 226 impl ChannelManager {
 227         /// Constructs a new ChannelManager to hold several channels and route between them. This is
 228         /// the main "logic hub" for all channel-related actions, and implements ChannelMessageHandler.
 229         /// fee_proportional_millionths is an optional fee to charge any payments routed through us.
 230         /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
 231         /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
 232         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> {
 233                 let secp_ctx = Secp256k1::new();
 234
 235                 let res = Arc::new(ChannelManager {
 236                         genesis_hash: genesis_block(network).header.bitcoin_hash(),
 237                         fee_estimator: feeest.clone(),
 238                         monitor: monitor.clone(),
 239                         chain_monitor,
 240                         tx_broadcaster,
 241
 242                         announce_channels_publicly,
 243                         fee_proportional_millionths,
 244                         latest_block_height: AtomicUsize::new(0), //TODO: Get an init value (generally need to replay recent chain on chain_monitor registration)
 245                         secp_ctx,
 246
 247                         channel_state: Mutex::new(ChannelHolder{
 248                                 by_id: HashMap::new(),
 249                                 short_to_id: HashMap::new(),
 250                                 next_forward: Instant::now(),
 251                                 forward_htlcs: HashMap::new(),
 252                                 claimable_htlcs: HashMap::new(),
 253                         }),
 254                         our_network_key,
 255
 256                         pending_events: Mutex::new(Vec::new()),
 257
 258                         logger,
 259                 });
 260                 let weak_res = Arc::downgrade(&res);
 261                 res.chain_monitor.register_listener(weak_res);
 262                 Ok(res)
 263         }
 264
 265         /// Creates a new outbound channel to the given remote node and with the given value.
 266         /// user_id will be provided back as user_channel_id in FundingGenerationReady and
 267         /// FundingBroadcastSafe events to allow tracking of which events correspond with which
 268         /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
 269         /// may wish to avoid using 0 for user_id here.
 270         /// If successful, will generate a SendOpenChannel event, so you should probably poll
 271         /// PeerManager::process_events afterwards.
 272         /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat being greater than channel_value_satoshis * 1k
 273         pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
 274                 let chan_keys = if cfg!(feature = "fuzztarget") {
 275                         ChannelKeys {
 276                                 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(),
 277                                 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(),
 278                                 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(),
 279                                 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(),
 280                                 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(),
 281                                 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(),
 282                                 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(),
 283                                 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],
 284                         }
 285                 } else {
 286                         let mut key_seed = [0u8; 32];
 287                         rng::fill_bytes(&mut key_seed);
 288                         match ChannelKeys::new_from_seed(&key_seed) {
 289                                 Ok(key) => key,
 290                                 Err(_) => panic!("RNG is busted!")
 291                         }
 292                 };
 293
 294                 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))?;
 295                 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator)?;
 296                 let mut channel_state = self.channel_state.lock().unwrap();
 297                 match channel_state.by_id.insert(channel.channel_id(), channel) {
 298                         Some(_) => panic!("RNG is bad???"),
 299                         None => {}
 300                 }
 301
 302                 let mut events = self.pending_events.lock().unwrap();
 303                 events.push(events::Event::SendOpenChannel {
 304                         node_id: their_network_key,
 305                         msg: res,
 306                 });
 307                 Ok(())
 308         }
 309
 310         /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
 311         /// more information.
 312         pub fn list_channels(&self) -> Vec<ChannelDetails> {
 313                 let channel_state = self.channel_state.lock().unwrap();
 314                 let mut res = Vec::with_capacity(channel_state.by_id.len());
 315                 for (channel_id, channel) in channel_state.by_id.iter() {
 316                         res.push(ChannelDetails {
 317                                 channel_id: (*channel_id).clone(),
 318                                 short_channel_id: channel.get_short_channel_id(),
 319                                 remote_network_id: channel.get_their_node_id(),
 320                                 channel_value_satoshis: channel.get_value_satoshis(),
 321                                 user_id: channel.get_user_id(),
 322                         });
 323                 }
 324                 res
 325         }
 326
 327         /// Gets the list of usable channels, in random order. Useful as an argument to
 328         /// Router::get_route to ensure non-announced channels are used.
 329         pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
 330                 let channel_state = self.channel_state.lock().unwrap();
 331                 let mut res = Vec::with_capacity(channel_state.by_id.len());
 332                 for (channel_id, channel) in channel_state.by_id.iter() {
 333                         if channel.is_usable() {
 334                                 res.push(ChannelDetails {
 335                                         channel_id: (*channel_id).clone(),
 336                                         short_channel_id: channel.get_short_channel_id(),
 337                                         remote_network_id: channel.get_their_node_id(),
 338                                         channel_value_satoshis: channel.get_value_satoshis(),
 339                                         user_id: channel.get_user_id(),
 340                                 });
 341                         }
 342                 }
 343                 res
 344         }
 345
 346         /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
 347         /// will be accepted on the given channel, and after additional timeout/the closing of all
 348         /// pending HTLCs, the channel will be closed on chain.
 349         /// May generate a SendShutdown event on success, which should be relayed.
 350         pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), HandleError> {
 351                 let (res, node_id, chan_option) = {
 352                         let mut channel_state_lock = self.channel_state.lock().unwrap();
 353                         let channel_state = channel_state_lock.borrow_parts();
 354                         match channel_state.by_id.entry(channel_id.clone()) {
 355                                 hash_map::Entry::Occupied(mut chan_entry) => {
 356                                         let res = chan_entry.get_mut().get_shutdown()?;
 357                                         if chan_entry.get().is_shutdown() {
 358                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
 359                                                         channel_state.short_to_id.remove(&short_id);
 360                                                 }
 361                                                 (res, chan_entry.get().get_their_node_id(), Some(chan_entry.remove_entry().1))
 362                                         } else { (res, chan_entry.get().get_their_node_id(), None) }
 363                                 },
 364                                 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "No such channel", action: None})
 365                         }
 366                 };
 367                 for payment_hash in res.1 {
 368                         // unknown_next_peer...I dunno who that is anymore....
 369                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
 370                 }
 371                 let chan_update = if let Some(chan) = chan_option {
 372                         if let Ok(update) = self.get_channel_update(&chan) {
 373                                 Some(update)
 374                         } else { None }
 375                 } else { None };
 376
 377                 let mut events = self.pending_events.lock().unwrap();
 378                 if let Some(update) = chan_update {
 379                         events.push(events::Event::BroadcastChannelUpdate {
 380                                 msg: update
 381                         });
 382                 }
 383                 events.push(events::Event::SendShutdown {
 384                         node_id,
 385                         msg: res.0
 386                 });
 387
 388                 Ok(())
 389         }
 390
 391         #[inline]
 392         fn finish_force_close_channel(&self, shutdown_res: (Vec<Transaction>, Vec<[u8; 32]>)) {
 393                 let (local_txn, failed_htlcs) = shutdown_res;
 394                 for payment_hash in failed_htlcs {
 395                         // unknown_next_peer...I dunno who that is anymore....
 396                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
 397                 }
 398                 for tx in local_txn {
 399                         self.tx_broadcaster.broadcast_transaction(&tx);
 400                 }
 401                 //TODO: We need to have a way where outbound HTLC claims can result in us claiming the
 402                 //now-on-chain HTLC output for ourselves (and, thereafter, passing the HTLC backwards).
 403                 //TODO: We need to handle monitoring of pending offered HTLCs which just hit the chain and
 404                 //may be claimed, resulting in us claiming the inbound HTLCs (and back-failing after
 405                 //timeouts are hit and our claims confirm).
 406         }
 407
 408         /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
 409         /// the chain and rejecting new HTLCs on the given channel.
 410         pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
 411                 let mut chan = {
 412                         let mut channel_state_lock = self.channel_state.lock().unwrap();
 413                         let channel_state = channel_state_lock.borrow_parts();
 414                         if let Some(chan) = channel_state.by_id.remove(channel_id) {
 415                                 if let Some(short_id) = chan.get_short_channel_id() {
 416                                         channel_state.short_to_id.remove(&short_id);
 417                                 }
 418                                 chan
 419                         } else {
 420                                 return;
 421                         }
 422                 };
 423                 self.finish_force_close_channel(chan.force_shutdown());
 424                 let mut events = self.pending_events.lock().unwrap();
 425                 if let Ok(update) = self.get_channel_update(&chan) {
 426                         events.push(events::Event::BroadcastChannelUpdate {
 427                                 msg: update
 428                         });
 429                 }
 430         }
 431
 432         /// Force close all channels, immediately broadcasting the latest local commitment transaction
 433         /// for each to the chain and rejecting new HTLCs on each.
 434         pub fn force_close_all_channels(&self) {
 435                 for chan in self.list_channels() {
 436                         self.force_close_channel(&chan.channel_id);
 437                 }
 438         }
 439
 440         #[inline]
 441         fn gen_rho_mu_from_shared_secret(shared_secret: &SharedSecret) -> ([u8; 32], [u8; 32]) {
 442                 ({
 443                         let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
 444                         hmac.input(&shared_secret[..]);
 445                         let mut res = [0; 32];
 446                         hmac.raw_result(&mut res);
 447                         res
 448                 },
 449                 {
 450                         let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
 451                         hmac.input(&shared_secret[..]);
 452                         let mut res = [0; 32];
 453                         hmac.raw_result(&mut res);
 454                         res
 455                 })
 456         }
 457
 458         #[inline]
 459         fn gen_um_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
 460                 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
 461                 hmac.input(&shared_secret[..]);
 462                 let mut res = [0; 32];
 463                 hmac.raw_result(&mut res);
 464                 res
 465         }
 466
 467         #[inline]
 468         fn gen_ammag_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
 469                 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
 470                 hmac.input(&shared_secret[..]);
 471                 let mut res = [0; 32];
 472                 hmac.raw_result(&mut res);
 473                 res
 474         }
 475
 476         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
 477         #[inline]
 478         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<(), HandleError> {
 479                 let mut blinded_priv = session_priv.clone();
 480                 let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
 481                 let mut first_iteration = true;
 482
 483                 for hop in route.hops.iter() {
 484                         let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
 485
 486                         let mut sha = Sha256::new();
 487                         sha.input(&blinded_pub.serialize()[..]);
 488                         sha.input(&shared_secret[..]);
 489                         let mut blinding_factor = [0u8; 32];
 490                         sha.result(&mut blinding_factor);
 491
 492                         if first_iteration {
 493                                 blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
 494                                 first_iteration = false;
 495                         }
 496                         let ephemeral_pubkey = blinded_pub;
 497
 498                         secp_call!(blinded_priv.mul_assign(secp_ctx, &secp_call!(SecretKey::from_slice(secp_ctx, &blinding_factor))));
 499                         blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
 500
 501                         callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
 502                 }
 503
 504                 Ok(())
 505         }
 506
 507         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
 508         fn construct_onion_keys<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, HandleError> {
 509                 let mut res = Vec::with_capacity(route.hops.len());
 510
 511                 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
 512                         let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
 513
 514                         res.push(OnionKeys {
 515                                 #[cfg(test)]
 516                                 shared_secret,
 517                                 #[cfg(test)]
 518                                 blinding_factor: _blinding_factor,
 519                                 ephemeral_pubkey,
 520                                 rho,
 521                                 mu,
 522                         });
 523                 })?;
 524
 525                 Ok(res)
 526         }
 527
 528         /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
 529         fn build_onion_payloads(route: &Route, starting_htlc_offset: u32) -> Result<(Vec<msgs::OnionHopData>, u64, u32), HandleError> {
 530                 let mut cur_value_msat = 0u64;
 531                 let mut cur_cltv = starting_htlc_offset;
 532                 let mut last_short_channel_id = 0;
 533                 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
 534                 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
 535                 unsafe { res.set_len(route.hops.len()); }
 536
 537                 for (idx, hop) in route.hops.iter().enumerate().rev() {
 538                         // First hop gets special values so that it can check, on receipt, that everything is
 539                         // exactly as it should be (and the next hop isn't trying to probe to find out if we're
 540                         // the intended recipient).
 541                         let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
 542                         let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
 543                         res[idx] = msgs::OnionHopData {
 544                                 realm: 0,
 545                                 data: msgs::OnionRealm0HopData {
 546                                         short_channel_id: last_short_channel_id,
 547                                         amt_to_forward: value_msat,
 548                                         outgoing_cltv_value: cltv,
 549                                 },
 550                                 hmac: [0; 32],
 551                         };
 552                         cur_value_msat += hop.fee_msat;
 553                         if cur_value_msat >= 21000000 * 100000000 * 1000 {
 554                                 return Err(HandleError{err: "Channel fees overflowed?!", action: None});
 555                         }
 556                         cur_cltv += hop.cltv_expiry_delta as u32;
 557                         if cur_cltv >= 500000000 {
 558                                 return Err(HandleError{err: "Channel CLTV overflowed?!", action: None});
 559                         }
 560                         last_short_channel_id = hop.short_channel_id;
 561                 }
 562                 Ok((res, cur_value_msat, cur_cltv))
 563         }
 564
 565         #[inline]
 566         fn shift_arr_right(arr: &mut [u8; 20*65]) {
 567                 unsafe {
 568                         ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
 569                 }
 570                 for i in 0..65 {
 571                         arr[i] = 0;
 572                 }
 573         }
 574
 575         #[inline]
 576         fn xor_bufs(dst: &mut[u8], src: &[u8]) {
 577                 assert_eq!(dst.len(), src.len());
 578
 579                 for i in 0..dst.len() {
 580                         dst[i] ^= src[i];
 581                 }
 582         }
 583
 584         const ZERO:[u8; 21*65] = [0; 21*65];
 585         fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: &[u8; 32]) -> Result<msgs::OnionPacket, HandleError> {
 586                 let mut buf = Vec::with_capacity(21*65);
 587                 buf.resize(21*65, 0);
 588
 589                 let filler = {
 590                         let iters = payloads.len() - 1;
 591                         let end_len = iters * 65;
 592                         let mut res = Vec::with_capacity(end_len);
 593                         res.resize(end_len, 0);
 594
 595                         for (i, keys) in onion_keys.iter().enumerate() {
 596                                 if i == payloads.len() - 1 { continue; }
 597                                 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
 598                                 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
 599                                 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
 600                         }
 601                         res
 602                 };
 603
 604                 let mut packet_data = [0; 20*65];
 605                 let mut hmac_res = [0; 32];
 606
 607                 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
 608                         ChannelManager::shift_arr_right(&mut packet_data);
 609                         payload.hmac = hmac_res;
 610                         packet_data[0..65].copy_from_slice(&payload.encode()[..]);
 611
 612                         let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
 613                         chacha.process(&packet_data, &mut buf[0..20*65]);
 614                         packet_data[..].copy_from_slice(&buf[0..20*65]);
 615
 616                         if i == 0 {
 617                                 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
 618                         }
 619
 620                         let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
 621                         hmac.input(&packet_data);
 622                         hmac.input(&associated_data[..]);
 623                         hmac.raw_result(&mut hmac_res);
 624                 }
 625
 626                 Ok(msgs::OnionPacket{
 627                         version: 0,
 628                         public_key: Ok(onion_keys.first().unwrap().ephemeral_pubkey),
 629                         hop_data: packet_data,
 630                         hmac: hmac_res,
 631                 })
 632         }
 633
 634         /// Encrypts a failure packet. raw_packet can either be a
 635         /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
 636         fn encrypt_failure_packet(shared_secret: &SharedSecret, raw_packet: &[u8]) -> msgs::OnionErrorPacket {
 637                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
 638
 639                 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
 640                 packet_crypted.resize(raw_packet.len(), 0);
 641                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
 642                 chacha.process(&raw_packet, &mut packet_crypted[..]);
 643                 msgs::OnionErrorPacket {
 644                         data: packet_crypted,
 645                 }
 646         }
 647
 648         fn build_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
 649                 assert!(failure_data.len() <= 256 - 2);
 650
 651                 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
 652
 653                 let failuremsg = {
 654                         let mut res = Vec::with_capacity(2 + failure_data.len());
 655                         res.push(((failure_type >> 8) & 0xff) as u8);
 656                         res.push(((failure_type >> 0) & 0xff) as u8);
 657                         res.extend_from_slice(&failure_data[..]);
 658                         res
 659                 };
 660                 let pad = {
 661                         let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
 662                         res.resize(256 - 2 - failure_data.len(), 0);
 663                         res
 664                 };
 665                 let mut packet = msgs::DecodedOnionErrorPacket {
 666                         hmac: [0; 32],
 667                         failuremsg: failuremsg,
 668                         pad: pad,
 669                 };
 670
 671                 let mut hmac = Hmac::new(Sha256::new(), &um);
 672                 hmac.input(&packet.encode()[32..]);
 673                 hmac.raw_result(&mut packet.hmac);
 674
 675                 packet
 676         }
 677
 678         #[inline]
 679         fn build_first_hop_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
 680                 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
 681                 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
 682         }
 683
 684         fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, Option<SharedSecret>, MutexGuard<ChannelHolder>) {
 685                 macro_rules! get_onion_hash {
 686                         () => {
 687                                 {
 688                                         let mut sha = Sha256::new();
 689                                         sha.input(&msg.onion_routing_packet.hop_data);
 690                                         let mut onion_hash = [0; 32];
 691                                         sha.result(&mut onion_hash);
 692                                         onion_hash
 693                                 }
 694                         }
 695                 }
 696
 697                 if let Err(_) = msg.onion_routing_packet.public_key {
 698                         log_info!(self, "Failed to accept/forward incoming HTLC with invalid ephemeral pubkey");
 699                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
 700                                 channel_id: msg.channel_id,
 701                                 htlc_id: msg.htlc_id,
 702                                 sha256_of_onion: get_onion_hash!(),
 703                                 failure_code: 0x8000 | 0x4000 | 6,
 704                         })), None, self.channel_state.lock().unwrap());
 705                 }
 706
 707                 let shared_secret = SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key);
 708                 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
 709
 710                 let mut channel_state = None;
 711                 macro_rules! return_err {
 712                         ($msg: expr, $err_code: expr, $data: expr) => {
 713                                 {
 714                                         log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
 715                                         if channel_state.is_none() {
 716                                                 channel_state = Some(self.channel_state.lock().unwrap());
 717                                         }
 718                                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
 719                                                 channel_id: msg.channel_id,
 720                                                 htlc_id: msg.htlc_id,
 721                                                 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
 722                                         })), Some(shared_secret), channel_state.unwrap());
 723                                 }
 724                         }
 725                 }
 726
 727                 if msg.onion_routing_packet.version != 0 {
 728                         //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
 729                         //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
 730                         //the hash doesn't really serve any purpuse - in the case of hashing all data, the
 731                         //receiving node would have to brute force to figure out which version was put in the
 732                         //packet by the node that send us the message, in the case of hashing the hop_data, the
 733                         //node knows the HMAC matched, so they already know what is there...
 734                         return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
 735                 }
 736
 737                 let mut hmac = Hmac::new(Sha256::new(), &mu);
 738                 hmac.input(&msg.onion_routing_packet.hop_data);
 739                 hmac.input(&msg.payment_hash);
 740                 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
 741                         return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
 742                 }
 743
 744                 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
 745                 let next_hop_data = {
 746                         let mut decoded = [0; 65];
 747                         chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
 748                         match msgs::OnionHopData::decode(&decoded[..]) {
 749                                 Err(err) => {
 750                                         let error_code = match err {
 751                                                 msgs::DecodeError::UnknownRealmByte => 0x4000 | 1,
 752                                                 _ => 0x2000 | 2, // Should never happen
 753                                         };
 754                                         return_err!("Unable to decode our hop data", error_code, &[0;0]);
 755                                 },
 756                                 Ok(msg) => msg
 757                         }
 758                 };
 759
 760                 //TODO: Check that msg.cltv_expiry is within acceptable bounds!
 761
 762                 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
 763                                 // OUR PAYMENT!
 764                                 if next_hop_data.data.amt_to_forward != msg.amount_msat {
 765                                         return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
 766                                 }
 767                                 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
 768                                         return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
 769                                 }
 770
 771                                 // Note that we could obviously respond immediately with an update_fulfill_htlc
 772                                 // message, however that would leak that we are the recipient of this payment, so
 773                                 // instead we stay symmetric with the forwarding case, only responding (after a
 774                                 // delay) once they've send us a commitment_signed!
 775
 776                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
 777                                         onion_packet: None,
 778                                         payment_hash: msg.payment_hash.clone(),
 779                                         short_channel_id: 0,
 780                                         prev_short_channel_id: 0,
 781                                         amt_to_forward: next_hop_data.data.amt_to_forward,
 782                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
 783                                 })
 784                         } else {
 785                                 let mut new_packet_data = [0; 20*65];
 786                                 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
 787                                 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
 788
 789                                 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
 790
 791                                 let blinding_factor = {
 792                                         let mut sha = Sha256::new();
 793                                         sha.input(&new_pubkey.serialize()[..]);
 794                                         sha.input(&shared_secret[..]);
 795                                         let mut res = [0u8; 32];
 796                                         sha.result(&mut res);
 797                                         match SecretKey::from_slice(&self.secp_ctx, &res) {
 798                                                 Err(_) => {
 799                                                         return_err!("Blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
 800                                                 },
 801                                                 Ok(key) => key
 802                                         }
 803                                 };
 804
 805                                 if let Err(_) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
 806                                         return_err!("New blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
 807                                 }
 808
 809                                 let outgoing_packet = msgs::OnionPacket {
 810                                         version: 0,
 811                                         public_key: Ok(new_pubkey),
 812                                         hop_data: new_packet_data,
 813                                         hmac: next_hop_data.hmac.clone(),
 814                                 };
 815
 816                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
 817                                         onion_packet: Some(outgoing_packet),
 818                                         payment_hash: msg.payment_hash.clone(),
 819                                         short_channel_id: next_hop_data.data.short_channel_id,
 820                                         prev_short_channel_id: 0,
 821                                         amt_to_forward: next_hop_data.data.amt_to_forward,
 822                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
 823                                 })
 824                         };
 825
 826                 channel_state = Some(self.channel_state.lock().unwrap());
 827                 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
 828                         if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
 829                                 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
 830                                 let forwarding_id = match id_option {
 831                                         None => {
 832                                                 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
 833                                         },
 834                                         Some(id) => id.clone(),
 835                                 };
 836                                 if let Some((err, code, chan_update)) = {
 837                                         let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
 838                                         if !chan.is_live() {
 839                                                 Some(("Forwarding channel is not in a ready state.", 0x1000 | 7, self.get_channel_update(chan).unwrap()))
 840                                         } else {
 841                                                 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) });
 842                                                 if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward {
 843                                                         Some(("Prior hop has deviated from specified fees parameters or origin node has obsolete ones", 0x1000 | 12, self.get_channel_update(chan).unwrap()))
 844                                                 } else {
 845                                                         if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 {
 846                                                                 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()))
 847                                                         } else {
 848                                                                 None
 849                                                         }
 850                                                 }
 851                                         }
 852                                 } {
 853                                         return_err!(err, code, &chan_update.encode_with_len()[..]);
 854                                 }
 855                         }
 856                 }
 857
 858                 (pending_forward_info, Some(shared_secret), channel_state.unwrap())
 859         }
 860
 861         /// only fails if the channel does not yet have an assigned short_id
 862         fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
 863                 let short_channel_id = match chan.get_short_channel_id() {
 864                         None => return Err(HandleError{err: "Channel not yet established", action: None}),
 865                         Some(id) => id,
 866                 };
 867
 868                 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
 869
 870                 let unsigned = msgs::UnsignedChannelUpdate {
 871                         chain_hash: self.genesis_hash,
 872                         short_channel_id: short_channel_id,
 873                         timestamp: chan.get_channel_update_count(),
 874                         flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
 875                         cltv_expiry_delta: CLTV_EXPIRY_DELTA,
 876                         htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
 877                         fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
 878                         fee_proportional_millionths: self.fee_proportional_millionths,
 879                 };
 880
 881                 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
 882                 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key); //TODO Can we unwrap here?
 883
 884                 Ok(msgs::ChannelUpdate {
 885                         signature: sig,
 886                         contents: unsigned
 887                 })
 888         }
 889
 890         /// Sends a payment along a given route.
 891         /// Value parameters are provided via the last hop in route, see documentation for RouteHop
 892         /// fields for more info.
 893         /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
 894         /// payment), we don't do anything to stop you! We always try to ensure that if the provided
 895         /// next hop knows the preimage to payment_hash they can claim an additional amount as
 896         /// specified in the last hop in the route! Thus, you should probably do your own
 897         /// payment_preimage tracking (which you should already be doing as they represent "proof of
 898         /// payment") and prevent double-sends yourself.
 899         /// See-also docs on Channel::send_htlc_and_commit.
 900         /// May generate a SendHTLCs event on success, which should be relayed.
 901         pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), HandleError> {
 902                 if route.hops.len() < 1 || route.hops.len() > 20 {
 903                         return Err(HandleError{err: "Route didn't go anywhere/had bogus size", action: None});
 904                 }
 905                 let our_node_id = self.get_our_node_id();
 906                 for (idx, hop) in route.hops.iter().enumerate() {
 907                         if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
 908                                 return Err(HandleError{err: "Route went through us but wasn't a simple rebalance loop to us", action: None});
 909                         }
 910                 }
 911
 912                 let session_priv = secp_call!(SecretKey::from_slice(&self.secp_ctx, &{
 913                         let mut session_key = [0; 32];
 914                         rng::fill_bytes(&mut session_key);
 915                         session_key
 916                 }));
 917
 918                 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
 919
 920                 let onion_keys = ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv)?;
 921                 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height)?;
 922                 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &payment_hash)?;
 923
 924                 let (first_hop_node_id, (update_add, commitment_signed, chan_monitor)) = {
 925                         let mut channel_state_lock = self.channel_state.lock().unwrap();
 926                         let channel_state = channel_state_lock.borrow_parts();
 927
 928                         let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
 929                                 None => return Err(HandleError{err: "No channel available with first hop!", action: None}),
 930                                 Some(id) => id.clone()
 931                         };
 932
 933                         let claimable_htlc_entry = channel_state.claimable_htlcs.entry(payment_hash.clone());
 934                         if let hash_map::Entry::Occupied(_) = claimable_htlc_entry {
 935                                 return Err(HandleError{err: "Already had pending HTLC with the same payment_hash", action: None});
 936                         }
 937
 938                         let res = {
 939                                 let chan = channel_state.by_id.get_mut(&id).unwrap();
 940                                 if chan.get_their_node_id() != route.hops.first().unwrap().pubkey {
 941                                         return Err(HandleError{err: "Node ID mismatch on first hop!", action: None});
 942                                 }
 943                                 chan.send_htlc_and_commit(htlc_msat, payment_hash, htlc_cltv, onion_packet)?
 944                         };
 945
 946                         let first_hop_node_id = route.hops.first().unwrap().pubkey;
 947
 948                         claimable_htlc_entry.or_insert(PendingOutboundHTLC::OutboundRoute {
 949                                 route,
 950                                 session_priv,
 951                         });
 952
 953                         match res {
 954                                 Some(msgs) => (first_hop_node_id, msgs),
 955                                 None => return Ok(()),
 956                         }
 957                 };
 958
 959                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
 960                         unimplemented!(); // maybe remove from claimable_htlcs?
 961                 }
 962
 963                 let mut events = self.pending_events.lock().unwrap();
 964                 events.push(events::Event::UpdateHTLCs {
 965                         node_id: first_hop_node_id,
 966                         updates: msgs::CommitmentUpdate {
 967                                 update_add_htlcs: vec![update_add],
 968                                 update_fulfill_htlcs: Vec::new(),
 969                                 update_fail_htlcs: Vec::new(),
 970                                 update_fail_malformed_htlcs: Vec::new(),
 971                                 commitment_signed,
 972                         },
 973                 });
 974                 Ok(())
 975         }
 976
 977         /// Call this upon creation of a funding transaction for the given channel.
 978         /// Panics if a funding transaction has already been provided for this channel.
 979         /// May panic if the funding_txo is duplicative with some other channel (note that this should
 980         /// be trivially prevented by using unique funding transaction keys per-channel).
 981         pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
 982
 983                 macro_rules! add_pending_event {
 984                         ($event: expr) => {
 985                                 {
 986                                         let mut pending_events = self.pending_events.lock().unwrap();
 987                                         pending_events.push($event);
 988                                 }
 989                         }
 990                 }
 991
 992                 let (chan, msg, chan_monitor) = {
 993                         let mut channel_state = self.channel_state.lock().unwrap();
 994                         match channel_state.by_id.remove(temporary_channel_id) {
 995                                 Some(mut chan) => {
 996                                         match chan.get_outbound_funding_created(funding_txo) {
 997                                                 Ok(funding_msg) => {
 998                                                         (chan, funding_msg.0, funding_msg.1)
 999                                                 },
1000                                                 Err(e) => {
1001                                                         log_error!(self, "Got bad signatures: {}!", e.err);
1002                                                         mem::drop(channel_state);
1003                                                         add_pending_event!(events::Event::HandleError {
1004                                                                 node_id: chan.get_their_node_id(),
1005                                                                 action: e.action,
1006                                                         });
1007                                                         return;
1008                                                 },
1009                                         }
1010                                 },
1011                                 None => return
1012                         }
1013                 }; // Release channel lock for install_watch_outpoint call,
1014                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1015                         unimplemented!(); // maybe remove from claimable_htlcs?
1016                 }
1017                 add_pending_event!(events::Event::SendFundingCreated {
1018                         node_id: chan.get_their_node_id(),
1019                         msg: msg,
1020                 });
1021
1022                 let mut channel_state = self.channel_state.lock().unwrap();
1023                 match channel_state.by_id.entry(chan.channel_id()) {
1024                         hash_map::Entry::Occupied(_) => {
1025                                 panic!("Generated duplicate funding txid?");
1026                         },
1027                         hash_map::Entry::Vacant(e) => {
1028                                 e.insert(chan);
1029                         }
1030                 }
1031         }
1032
1033         fn get_announcement_sigs(&self, chan: &Channel) -> Result<Option<msgs::AnnouncementSignatures>, HandleError> {
1034                 if !chan.is_usable() || !chan.should_announce() { return Ok(None) }
1035
1036                 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone())?;
1037                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1038                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1039
1040                 Ok(Some(msgs::AnnouncementSignatures {
1041                         channel_id: chan.channel_id(),
1042                         short_channel_id: chan.get_short_channel_id().unwrap(),
1043                         node_signature: our_node_sig,
1044                         bitcoin_signature: our_bitcoin_sig,
1045                 }))
1046         }
1047
1048         /// Processes HTLCs which are pending waiting on random forward delay.
1049         /// Should only really ever be called in response to an PendingHTLCsForwardable event.
1050         /// Will likely generate further events.
1051         pub fn process_pending_htlc_forwards(&self) {
1052                 let mut new_events = Vec::new();
1053                 let mut failed_forwards = Vec::new();
1054                 {
1055                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1056                         let channel_state = channel_state_lock.borrow_parts();
1057
1058                         if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
1059                                 return;
1060                         }
1061
1062                         for (short_chan_id, pending_forwards) in channel_state.forward_htlcs.drain() {
1063                                 if short_chan_id != 0 {
1064                                         let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1065                                                 Some(chan_id) => chan_id.clone(),
1066                                                 None => {
1067                                                         failed_forwards.reserve(pending_forwards.len());
1068                                                         for forward_info in pending_forwards {
1069                                                                 failed_forwards.push((forward_info.payment_hash, 0x4000 | 10, None));
1070                                                         }
1071                                                         continue;
1072                                                 }
1073                                         };
1074                                         let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
1075
1076                                         let mut add_htlc_msgs = Vec::new();
1077                                         for forward_info in pending_forwards {
1078                                                 match forward_chan.send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, forward_info.onion_packet.unwrap()) {
1079                                                         Err(_e) => {
1080                                                                 let chan_update = self.get_channel_update(forward_chan).unwrap();
1081                                                                 failed_forwards.push((forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1082                                                                 continue;
1083                                                         },
1084                                                         Ok(update_add) => {
1085                                                                 match update_add {
1086                                                                         Some(msg) => { add_htlc_msgs.push(msg); },
1087                                                                         None => {
1088                                                                                 // Nothing to do here...we're waiting on a remote
1089                                                                                 // revoke_and_ack before we can add anymore HTLCs. The Channel
1090                                                                                 // will automatically handle building the update_add_htlc and
1091                                                                                 // commitment_signed messages when we can.
1092                                                                                 // TODO: Do some kind of timer to set the channel as !is_live()
1093                                                                                 // as we don't really want others relying on us relaying through
1094                                                                                 // this channel currently :/.
1095                                                                         }
1096                                                                 }
1097                                                         }
1098                                                 }
1099                                         }
1100
1101                                         if !add_htlc_msgs.is_empty() {
1102                                                 let (commitment_msg, monitor) = match forward_chan.send_commitment() {
1103                                                         Ok(res) => res,
1104                                                         Err(_e) => {
1105                                                                 //TODO: Handle...this is bad!
1106                                                                 continue;
1107                                                         },
1108                                                 };
1109                                                 new_events.push((Some(monitor), events::Event::UpdateHTLCs {
1110                                                         node_id: forward_chan.get_their_node_id(),
1111                                                         updates: msgs::CommitmentUpdate {
1112                                                                 update_add_htlcs: add_htlc_msgs,
1113                                                                 update_fulfill_htlcs: Vec::new(),
1114                                                                 update_fail_htlcs: Vec::new(),
1115                                                                 update_fail_malformed_htlcs: Vec::new(),
1116                                                                 commitment_signed: commitment_msg,
1117                                                         },
1118                                                 }));
1119                                         }
1120                                 } else {
1121                                         for forward_info in pending_forwards {
1122                                                 new_events.push((None, events::Event::PaymentReceived {
1123                                                         payment_hash: forward_info.payment_hash,
1124                                                         amt: forward_info.amt_to_forward,
1125                                                 }));
1126                                         }
1127                                 }
1128                         }
1129                 }
1130
1131                 for failed_forward in failed_forwards.drain(..) {
1132                         match failed_forward.2 {
1133                                 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failed_forward.0, HTLCFailReason::Reason { failure_code: failed_forward.1, data: Vec::new() }),
1134                                 Some(chan_update) => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failed_forward.0, HTLCFailReason::Reason { failure_code: failed_forward.1, data: chan_update.encode_with_len() }),
1135                         };
1136                 }
1137
1138                 if new_events.is_empty() { return }
1139
1140                 new_events.retain(|event| {
1141                         if let &Some(ref monitor) = &event.0 {
1142                                 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor.clone()) {
1143                                         unimplemented!();// but def dont push the event...
1144                                 }
1145                         }
1146                         true
1147                 });
1148
1149                 let mut events = self.pending_events.lock().unwrap();
1150                 events.reserve(new_events.len());
1151                 for event in new_events.drain(..) {
1152                         events.push(event.1);
1153                 }
1154         }
1155
1156         /// Indicates that the preimage for payment_hash is unknown after a PaymentReceived event.
1157         pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32]) -> bool {
1158                 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: Vec::new() })
1159         }
1160
1161         /// Fails an HTLC backwards to the sender of it to us.
1162         /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1163         /// There are several callsites that do stupid things like loop over a list of payment_hashes
1164         /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1165         /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1166         /// still-available channels.
1167         fn fail_htlc_backwards_internal(&self, mut channel_state: MutexGuard<ChannelHolder>, payment_hash: &[u8; 32], onion_error: HTLCFailReason) -> bool {
1168                 let mut pending_htlc = {
1169                         match channel_state.claimable_htlcs.remove(payment_hash) {
1170                                 Some(pending_htlc) => pending_htlc,
1171                                 None => return false,
1172                         }
1173                 };
1174
1175                 match pending_htlc {
1176                         PendingOutboundHTLC::CycledRoute { source_short_channel_id, incoming_packet_shared_secret, route, session_priv } => {
1177                                 channel_state.claimable_htlcs.insert(payment_hash.clone(), PendingOutboundHTLC::OutboundRoute {
1178                                         route,
1179                                         session_priv,
1180                                 });
1181                                 pending_htlc = PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret };
1182                         },
1183                         _ => {}
1184                 }
1185
1186                 match pending_htlc {
1187                         PendingOutboundHTLC::CycledRoute { .. } => unreachable!(),
1188                         PendingOutboundHTLC::OutboundRoute { .. } => {
1189                                 mem::drop(channel_state);
1190
1191                                 let mut pending_events = self.pending_events.lock().unwrap();
1192                                 pending_events.push(events::Event::PaymentFailed {
1193                                         payment_hash: payment_hash.clone()
1194                                 });
1195                                 false
1196                         },
1197                         PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret } => {
1198                                 let err_packet = match onion_error {
1199                                         HTLCFailReason::Reason { failure_code, data } => {
1200                                                 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1201                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1202                                         },
1203                                         HTLCFailReason::ErrorPacket { err } => {
1204                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1205                                         }
1206                                 };
1207
1208                                 let (node_id, fail_msgs) = {
1209                                         let chan_id = match channel_state.short_to_id.get(&source_short_channel_id) {
1210                                                 Some(chan_id) => chan_id.clone(),
1211                                                 None => return false
1212                                         };
1213
1214                                         let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1215                                         match chan.get_update_fail_htlc_and_commit(payment_hash, err_packet) {
1216                                                 Ok(msg) => (chan.get_their_node_id(), msg),
1217                                                 Err(_e) => {
1218                                                         //TODO: Do something with e?
1219                                                         return false;
1220                                                 },
1221                                         }
1222                                 };
1223
1224                                 match fail_msgs {
1225                                         Some((msg, commitment_msg, chan_monitor)) => {
1226                                                 mem::drop(channel_state);
1227
1228                                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1229                                                         unimplemented!();// but def dont push the event...
1230                                                 }
1231
1232                                                 let mut pending_events = self.pending_events.lock().unwrap();
1233                                                 pending_events.push(events::Event::UpdateHTLCs {
1234                                                         node_id,
1235                                                         updates: msgs::CommitmentUpdate {
1236                                                                 update_add_htlcs: Vec::new(),
1237                                                                 update_fulfill_htlcs: Vec::new(),
1238                                                                 update_fail_htlcs: vec![msg],
1239                                                                 update_fail_malformed_htlcs: Vec::new(),
1240                                                                 commitment_signed: commitment_msg,
1241                                                         },
1242                                                 });
1243                                         },
1244                                         None => {},
1245                                 }
1246
1247                                 true
1248                         },
1249                 }
1250         }
1251
1252         /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1253         /// generating message events for the net layer to claim the payment, if possible. Thus, you
1254         /// should probably kick the net layer to go send messages if this returns true!
1255         /// May panic if called except in response to a PaymentReceived event.
1256         pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
1257                 self.claim_funds_internal(payment_preimage, true)
1258         }
1259         fn claim_funds_internal(&self, payment_preimage: [u8; 32], from_user: bool) -> bool {
1260                 let mut sha = Sha256::new();
1261                 sha.input(&payment_preimage);
1262                 let mut payment_hash = [0; 32];
1263                 sha.result(&mut payment_hash);
1264
1265                 let mut channel_state = self.channel_state.lock().unwrap();
1266                 let mut pending_htlc = {
1267                         match channel_state.claimable_htlcs.remove(&payment_hash) {
1268                                 Some(pending_htlc) => pending_htlc,
1269                                 None => return false,
1270                         }
1271                 };
1272
1273                 match pending_htlc {
1274                         PendingOutboundHTLC::CycledRoute { source_short_channel_id, incoming_packet_shared_secret, route, session_priv } => {
1275                                 if from_user { // This was the end hop back to us
1276                                         pending_htlc = PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret };
1277                                         channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::OutboundRoute { route, session_priv });
1278                                 } else { // This came from the first upstream node
1279                                         // Bank error in our favor! Maybe we should tell the user this somehow???
1280                                         pending_htlc = PendingOutboundHTLC::OutboundRoute { route, session_priv };
1281                                         channel_state.claimable_htlcs.insert(payment_hash, PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, incoming_packet_shared_secret });
1282                                 }
1283                         },
1284                         _ => {},
1285                 }
1286
1287                 match pending_htlc {
1288                         PendingOutboundHTLC::CycledRoute { .. } => unreachable!(),
1289                         PendingOutboundHTLC::OutboundRoute { .. } => {
1290                                 if from_user {
1291                                         panic!("Called claim_funds with a preimage for an outgoing payment. There is nothing we can do with this, and something is seriously wrong if you knew this...");
1292                                 }
1293                                 mem::drop(channel_state);
1294                                 let mut pending_events = self.pending_events.lock().unwrap();
1295                                 pending_events.push(events::Event::PaymentSent {
1296                                         payment_preimage
1297                                 });
1298                                 false
1299                         },
1300                         PendingOutboundHTLC::IntermediaryHopData { source_short_channel_id, .. } => {
1301                                 let (node_id, fulfill_msgs) = {
1302                                         let chan_id = match channel_state.short_to_id.get(&source_short_channel_id) {
1303                                                 Some(chan_id) => chan_id.clone(),
1304                                                 None => {
1305                                                         // TODO: There is probably a channel manager somewhere that needs to
1306                                                         // learn the preimage as the channel already hit the chain and that's
1307                                                         // why its missing.
1308                                                         return false
1309                                                 }
1310                                         };
1311
1312                                         let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1313                                         match chan.get_update_fulfill_htlc_and_commit(payment_preimage) {
1314                                                 Ok(msg) => (chan.get_their_node_id(), msg),
1315                                                 Err(_e) => {
1316                                                         // TODO: There is probably a channel manager somewhere that needs to
1317                                                         // learn the preimage as the channel may be about to hit the chain.
1318                                                         //TODO: Do something with e?
1319                                                         return false;
1320                                                 },
1321                                         }
1322                                 };
1323
1324                                 mem::drop(channel_state);
1325                                 if let Some(chan_monitor) = fulfill_msgs.1 {
1326                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1327                                                 unimplemented!();// but def dont push the event...
1328                                         }
1329                                 }
1330
1331                                 if let Some((msg, commitment_msg)) = fulfill_msgs.0 {
1332                                         let mut pending_events = self.pending_events.lock().unwrap();
1333                                         pending_events.push(events::Event::UpdateHTLCs {
1334                                                 node_id: node_id,
1335                                                 updates: msgs::CommitmentUpdate {
1336                                                         update_add_htlcs: Vec::new(),
1337                                                         update_fulfill_htlcs: vec![msg],
1338                                                         update_fail_htlcs: Vec::new(),
1339                                                         update_fail_malformed_htlcs: Vec::new(),
1340                                                         commitment_signed: commitment_msg,
1341                                                 }
1342                                         });
1343                                 }
1344                                 true
1345                         },
1346                 }
1347         }
1348
1349         /// Gets the node_id held by this ChannelManager
1350         pub fn get_our_node_id(&self) -> PublicKey {
1351                 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1352         }
1353
1354         /// Used to restore channels to normal operation after a
1355         /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1356         /// operation.
1357         pub fn test_restore_channel_monitor(&self) {
1358                 unimplemented!();
1359         }
1360 }
1361
1362 impl events::EventsProvider for ChannelManager {
1363         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
1364                 let mut pending_events = self.pending_events.lock().unwrap();
1365                 let mut ret = Vec::new();
1366                 mem::swap(&mut ret, &mut *pending_events);
1367                 ret
1368         }
1369 }
1370
1371 impl ChainListener for ChannelManager {
1372         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
1373                 let mut new_events = Vec::new();
1374                 let mut failed_channels = Vec::new();
1375                 {
1376                         let mut channel_lock = self.channel_state.lock().unwrap();
1377                         let channel_state = channel_lock.borrow_parts();
1378                         let short_to_id = channel_state.short_to_id;
1379                         channel_state.by_id.retain(|_, channel| {
1380                                 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
1381                                 if let Ok(Some(funding_locked)) = chan_res {
1382                                         let announcement_sigs = match self.get_announcement_sigs(channel) {
1383                                                 Ok(res) => res,
1384                                                 Err(e) => {
1385                                                         log_error!(self, "Got error handling message: {}!", e.err);
1386                                                         //TODO: push e on events and blow up the channel (it has bad keys)
1387                                                         return true;
1388                                                 }
1389                                         };
1390                                         new_events.push(events::Event::SendFundingLocked {
1391                                                 node_id: channel.get_their_node_id(),
1392                                                 msg: funding_locked,
1393                                                 announcement_sigs: announcement_sigs
1394                                         });
1395                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
1396                                 } else if let Err(e) = chan_res {
1397                                         new_events.push(events::Event::HandleError {
1398                                                 node_id: channel.get_their_node_id(),
1399                                                 action: e.action,
1400                                         });
1401                                         if channel.is_shutdown() {
1402                                                 return false;
1403                                         }
1404                                 }
1405                                 if let Some(funding_txo) = channel.get_funding_txo() {
1406                                         for tx in txn_matched {
1407                                                 for inp in tx.input.iter() {
1408                                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
1409                                                                 if let Some(short_id) = channel.get_short_channel_id() {
1410                                                                         short_to_id.remove(&short_id);
1411                                                                 }
1412                                                                 // It looks like our counterparty went on-chain. We go ahead and
1413                                                                 // broadcast our latest local state as well here, just in case its
1414                                                                 // some kind of SPV attack, though we expect these to be dropped.
1415                                                                 failed_channels.push(channel.force_shutdown());
1416                                                                 if let Ok(update) = self.get_channel_update(&channel) {
1417                                                                         new_events.push(events::Event::BroadcastChannelUpdate {
1418                                                                                 msg: update
1419                                                                         });
1420                                                                 }
1421                                                                 return false;
1422                                                         }
1423                                                 }
1424                                         }
1425                                 }
1426                                 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
1427                                         if let Some(short_id) = channel.get_short_channel_id() {
1428                                                 short_to_id.remove(&short_id);
1429                                         }
1430                                         failed_channels.push(channel.force_shutdown());
1431                                         // If would_broadcast_at_height() is true, the channel_monitor will broadcast
1432                                         // the latest local tx for us, so we should skip that here (it doesn't really
1433                                         // hurt anything, but does make tests a bit simpler).
1434                                         failed_channels.last_mut().unwrap().0 = Vec::new();
1435                                         if let Ok(update) = self.get_channel_update(&channel) {
1436                                                 new_events.push(events::Event::BroadcastChannelUpdate {
1437                                                         msg: update
1438                                                 });
1439                                         }
1440                                         return false;
1441                                 }
1442                                 true
1443                         });
1444                 }
1445                 for failure in failed_channels.drain(..) {
1446                         self.finish_force_close_channel(failure);
1447                 }
1448                 let mut pending_events = self.pending_events.lock().unwrap();
1449                 for funding_locked in new_events.drain(..) {
1450                         pending_events.push(funding_locked);
1451                 }
1452                 self.latest_block_height.store(height as usize, Ordering::Release);
1453         }
1454
1455         /// We force-close the channel without letting our counterparty participate in the shutdown
1456         fn block_disconnected(&self, header: &BlockHeader) {
1457                 let mut new_events = Vec::new();
1458                 let mut failed_channels = Vec::new();
1459                 {
1460                         let mut channel_lock = self.channel_state.lock().unwrap();
1461                         let channel_state = channel_lock.borrow_parts();
1462                         let short_to_id = channel_state.short_to_id;
1463                         channel_state.by_id.retain(|_,  v| {
1464                                 if v.block_disconnected(header) {
1465                                         if let Some(short_id) = v.get_short_channel_id() {
1466                                                 short_to_id.remove(&short_id);
1467                                         }
1468                                         failed_channels.push(v.force_shutdown());
1469                                         if let Ok(update) = self.get_channel_update(&v) {
1470                                                 new_events.push(events::Event::BroadcastChannelUpdate {
1471                                                         msg: update
1472                                                 });
1473                                         }
1474                                         false
1475                                 } else {
1476                                         true
1477                                 }
1478                         });
1479                 }
1480                 for failure in failed_channels.drain(..) {
1481                         self.finish_force_close_channel(failure);
1482                 }
1483                 if !new_events.is_empty() {
1484                         let mut pending_events = self.pending_events.lock().unwrap();
1485                         for funding_locked in new_events.drain(..) {
1486                                 pending_events.push(funding_locked);
1487                         }
1488                 }
1489                 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
1490         }
1491 }
1492
1493 impl ChannelMessageHandler for ChannelManager {
1494         //TODO: Handle errors and close channel (or so)
1495         fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<msgs::AcceptChannel, HandleError> {
1496                 if msg.chain_hash != self.genesis_hash {
1497                         return Err(HandleError{err: "Unknown genesis block hash", action: None});
1498                 }
1499                 let mut channel_state = self.channel_state.lock().unwrap();
1500                 if channel_state.by_id.contains_key(&msg.temporary_channel_id) {
1501                         return Err(HandleError{err: "temporary_channel_id collision!", action: None});
1502                 }
1503
1504                 let chan_keys = if cfg!(feature = "fuzztarget") {
1505                         ChannelKeys {
1506                                 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(),
1507                                 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(),
1508                                 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(),
1509                                 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(),
1510                                 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(),
1511                                 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(),
1512                                 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(),
1513                                 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],
1514                         }
1515                 } else {
1516                         let mut key_seed = [0u8; 32];
1517                         rng::fill_bytes(&mut key_seed);
1518                         match ChannelKeys::new_from_seed(&key_seed) {
1519                                 Ok(key) => key,
1520                                 Err(_) => panic!("RNG is busted!")
1521                         }
1522                 };
1523
1524                 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))?;
1525                 let accept_msg = channel.get_accept_channel()?;
1526                 channel_state.by_id.insert(channel.channel_id(), channel);
1527                 Ok(accept_msg)
1528         }
1529
1530         fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
1531                 let (value, output_script, user_id) = {
1532                         let mut channel_state = self.channel_state.lock().unwrap();
1533                         match channel_state.by_id.get_mut(&msg.temporary_channel_id) {
1534                                 Some(chan) => {
1535                                         if chan.get_their_node_id() != *their_node_id {
1536                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1537                                         }
1538                                         chan.accept_channel(&msg)?;
1539                                         (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id())
1540                                 },
1541                                 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1542                         }
1543                 };
1544                 let mut pending_events = self.pending_events.lock().unwrap();
1545                 pending_events.push(events::Event::FundingGenerationReady {
1546                         temporary_channel_id: msg.temporary_channel_id,
1547                         channel_value_satoshis: value,
1548                         output_script: output_script,
1549                         user_channel_id: user_id,
1550                 });
1551                 Ok(())
1552         }
1553
1554         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<msgs::FundingSigned, HandleError> {
1555                 let (chan, funding_msg, monitor_update) = {
1556                         let mut channel_state = self.channel_state.lock().unwrap();
1557                         match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1558                                 hash_map::Entry::Occupied(mut chan) => {
1559                                         if chan.get().get_their_node_id() != *their_node_id {
1560                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1561                                         }
1562                                         match chan.get_mut().funding_created(msg) {
1563                                                 Ok((funding_msg, monitor_update)) => {
1564                                                         (chan.remove(), funding_msg, monitor_update)
1565                                                 },
1566                                                 Err(e) => {
1567                                                         //TODO: Possibly remove the channel depending on e.action
1568                                                         return Err(e);
1569                                                 }
1570                                         }
1571                                 },
1572                                 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1573                         }
1574                 }; // Release channel lock for install_watch_outpoint call,
1575                    // note that this means if the remote end is misbehaving and sends a message for the same
1576                    // channel back-to-back with funding_created, we'll end up thinking they sent a message
1577                    // for a bogus channel.
1578                 if let Err(_e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1579                         unimplemented!();
1580                 }
1581                 let mut channel_state = self.channel_state.lock().unwrap();
1582                 match channel_state.by_id.entry(funding_msg.channel_id) {
1583                         hash_map::Entry::Occupied(_) => {
1584                                 return Err(HandleError {
1585                                         err: "Duplicate channel_id!",
1586                                         action: Some(msgs::ErrorAction::SendErrorMessage { msg: msgs::ErrorMessage { channel_id: funding_msg.channel_id, data: "Already had channel with the new channel_id".to_owned() } })
1587                                 });
1588                         },
1589                         hash_map::Entry::Vacant(e) => {
1590                                 e.insert(chan);
1591                         }
1592                 }
1593                 Ok(funding_msg)
1594         }
1595
1596         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
1597                 let (funding_txo, user_id, monitor) = {
1598                         let mut channel_state = self.channel_state.lock().unwrap();
1599                         match channel_state.by_id.get_mut(&msg.channel_id) {
1600                                 Some(chan) => {
1601                                         if chan.get_their_node_id() != *their_node_id {
1602                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1603                                         }
1604                                         let chan_monitor = chan.funding_signed(&msg)?;
1605                                         (chan.get_funding_txo().unwrap(), chan.get_user_id(), chan_monitor)
1606                                 },
1607                                 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1608                         }
1609                 };
1610                 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1611                         unimplemented!();
1612                 }
1613                 let mut pending_events = self.pending_events.lock().unwrap();
1614                 pending_events.push(events::Event::FundingBroadcastSafe {
1615                         funding_txo: funding_txo,
1616                         user_channel_id: user_id,
1617                 });
1618                 Ok(())
1619         }
1620
1621         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<Option<msgs::AnnouncementSignatures>, HandleError> {
1622                 let mut channel_state = self.channel_state.lock().unwrap();
1623                 match channel_state.by_id.get_mut(&msg.channel_id) {
1624                         Some(chan) => {
1625                                 if chan.get_their_node_id() != *their_node_id {
1626                                         return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1627                                 }
1628                                 chan.funding_locked(&msg)?;
1629                                 return Ok(self.get_announcement_sigs(chan)?);
1630                         },
1631                         None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1632                 };
1633         }
1634
1635         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(Option<msgs::Shutdown>, Option<msgs::ClosingSigned>), HandleError> {
1636                 let (res, chan_option) = {
1637                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1638                         let channel_state = channel_state_lock.borrow_parts();
1639
1640                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1641                                 hash_map::Entry::Occupied(mut chan_entry) => {
1642                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1643                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1644                                         }
1645                                         let res = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg)?;
1646                                         if chan_entry.get().is_shutdown() {
1647                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1648                                                         channel_state.short_to_id.remove(&short_id);
1649                                                 }
1650                                                 (res, Some(chan_entry.remove_entry().1))
1651                                         } else { (res, None) }
1652                                 },
1653                                 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1654                         }
1655                 };
1656                 for payment_hash in res.2 {
1657                         // unknown_next_peer...I dunno who that is anymore....
1658                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
1659                 }
1660                 if let Some(chan) = chan_option {
1661                         if let Ok(update) = self.get_channel_update(&chan) {
1662                                 let mut events = self.pending_events.lock().unwrap();
1663                                 events.push(events::Event::BroadcastChannelUpdate {
1664                                         msg: update
1665                                 });
1666                         }
1667                 }
1668                 Ok((res.0, res.1))
1669         }
1670
1671         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<Option<msgs::ClosingSigned>, HandleError> {
1672                 let (res, chan_option) = {
1673                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1674                         let channel_state = channel_state_lock.borrow_parts();
1675                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1676                                 hash_map::Entry::Occupied(mut chan_entry) => {
1677                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1678                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1679                                         }
1680                                         let res = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg)?;
1681                                         if res.1.is_some() {
1682                                                 // We're done with this channel, we've got a signed closing transaction and
1683                                                 // will send the closing_signed back to the remote peer upon return. This
1684                                                 // also implies there are no pending HTLCs left on the channel, so we can
1685                                                 // fully delete it from tracking (the channel monitor is still around to
1686                                                 // watch for old state broadcasts)!
1687                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1688                                                         channel_state.short_to_id.remove(&short_id);
1689                                                 }
1690                                                 (res, Some(chan_entry.remove_entry().1))
1691                                         } else { (res, None) }
1692                                 },
1693                                 hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1694                         }
1695                 };
1696                 if let Some(broadcast_tx) = res.1 {
1697                         self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
1698                 }
1699                 if let Some(chan) = chan_option {
1700                         if let Ok(update) = self.get_channel_update(&chan) {
1701                                 let mut events = self.pending_events.lock().unwrap();
1702                                 events.push(events::Event::BroadcastChannelUpdate {
1703                                         msg: update
1704                                 });
1705                         }
1706                 }
1707                 Ok(res.0)
1708         }
1709
1710         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
1711                 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
1712                 //determine the state of the payment based on our response/if we forward anything/the time
1713                 //we take to respond. We should take care to avoid allowing such an attack.
1714                 //
1715                 //TODO: There exists a further attack where a node may garble the onion data, forward it to
1716                 //us repeatedly garbled in different ways, and compare our error messages, which are
1717                 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
1718                 //but we should prevent it anyway.
1719
1720                 let (mut pending_forward_info, shared_secret, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
1721                 let channel_state = channel_state_lock.borrow_parts();
1722
1723                 let claimable_htlcs_entry = channel_state.claimable_htlcs.entry(msg.payment_hash.clone());
1724
1725                 // We dont correctly handle payments that route through us twice on their way to their
1726                 // destination. That's OK since those nodes are probably busted or trying to do network
1727                 // mapping through repeated loops. In either case, we want them to stop talking to us, so
1728                 // we send permanent_node_failure.
1729                 let mut will_forward = false;
1730                 if let PendingHTLCStatus::Forward(PendingForwardHTLCInfo { short_channel_id, .. }) = pending_forward_info {
1731                         if let &hash_map::Entry::Occupied(ref e) = &claimable_htlcs_entry {
1732                                 let mut acceptable_cycle = false;
1733                                 if let &PendingOutboundHTLC::OutboundRoute { .. } = e.get() {
1734                                         acceptable_cycle = short_channel_id == 0;
1735                                 }
1736                                 if !acceptable_cycle {
1737                                         log_info!(self, "Failed to accept incoming HTLC: Payment looped through us twice");
1738                                         pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1739                                                 channel_id: msg.channel_id,
1740                                                 htlc_id: msg.htlc_id,
1741                                                 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret.unwrap(), 0x4000 | 0x2000 | 2, &[0;0]),
1742                                         }));
1743                                 } else {
1744                                         will_forward = true;
1745                                 }
1746                         } else {
1747                                 will_forward = true;
1748                         }
1749                 }
1750
1751                 let (source_short_channel_id, res) = match channel_state.by_id.get_mut(&msg.channel_id) {
1752                         Some(chan) => {
1753                                 if chan.get_their_node_id() != *their_node_id {
1754                                         return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1755                                 }
1756                                 if !chan.is_usable() {
1757                                         return Err(HandleError{err: "Channel not yet available for receiving HTLCs", action: None});
1758                                 }
1759                                 let short_channel_id = chan.get_short_channel_id().unwrap();
1760                                 if let PendingHTLCStatus::Forward(ref mut forward_info) = pending_forward_info {
1761                                         forward_info.prev_short_channel_id = short_channel_id;
1762                                 }
1763                                 (short_channel_id, chan.update_add_htlc(&msg, pending_forward_info)?)
1764                         },
1765                         None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}),
1766                 };
1767
1768                 if will_forward {
1769                         match claimable_htlcs_entry {
1770                                 hash_map::Entry::Occupied(mut e) => {
1771                                         let outbound_route = e.get_mut();
1772                                         let (route, session_priv) = match outbound_route {
1773                                                 &mut PendingOutboundHTLC::OutboundRoute { ref route, ref session_priv } => {
1774                                                         (route.clone(), session_priv.clone())
1775                                                 },
1776                                                 _ => unreachable!(),
1777                                         };
1778                                         *outbound_route = PendingOutboundHTLC::CycledRoute {
1779                                                 source_short_channel_id,
1780                                                 incoming_packet_shared_secret: shared_secret.unwrap(),
1781                                                 route,
1782                                                 session_priv,
1783                                         };
1784                                 },
1785                                 hash_map::Entry::Vacant(e) => {
1786                                         e.insert(PendingOutboundHTLC::IntermediaryHopData {
1787                                                 source_short_channel_id,
1788                                                 incoming_packet_shared_secret: shared_secret.unwrap(),
1789                                         });
1790                                 }
1791                         }
1792                 }
1793
1794                 Ok(res)
1795         }
1796
1797         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
1798                 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1799                 // Claim funds first, cause we don't really care if the channel we received the message on
1800                 // is broken, we may have enough info to get our own money!
1801                 self.claim_funds_internal(msg.payment_preimage.clone(), false);
1802
1803                 let mut channel_state = self.channel_state.lock().unwrap();
1804                 match channel_state.by_id.get_mut(&msg.channel_id) {
1805                         Some(chan) => {
1806                                 if chan.get_their_node_id() != *their_node_id {
1807                                         return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1808                                 }
1809                                 chan.update_fulfill_htlc(&msg)
1810                         },
1811                         None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1812                 }
1813         }
1814
1815         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<Option<msgs::HTLCFailChannelUpdate>, HandleError> {
1816                 let mut channel_state = self.channel_state.lock().unwrap();
1817                 let payment_hash = match channel_state.by_id.get_mut(&msg.channel_id) {
1818                         Some(chan) => {
1819                                 if chan.get_their_node_id() != *their_node_id {
1820                                         return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1821                                 }
1822                                 chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() })
1823                         },
1824                         None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1825                 }?;
1826
1827                 if let Some(pending_htlc) = channel_state.claimable_htlcs.get(&payment_hash) {
1828                         match pending_htlc {
1829                                 &PendingOutboundHTLC::OutboundRoute { ref route, ref session_priv } => {
1830                                         // Handle packed channel/node updates for passing back for the route handler
1831                                         let mut packet_decrypted = msg.reason.data.clone();
1832                                         let mut res = None;
1833                                         Self::construct_onion_keys_callback(&self.secp_ctx, &route, &session_priv, |shared_secret, _, _, route_hop| {
1834                                                 if res.is_some() { return; }
1835
1836                                                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
1837
1838                                                 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
1839                                                 decryption_tmp.resize(packet_decrypted.len(), 0);
1840                                                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
1841                                                 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
1842                                                 packet_decrypted = decryption_tmp;
1843
1844                                                 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::decode(&packet_decrypted) {
1845                                                         if err_packet.failuremsg.len() >= 2 {
1846                                                                 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
1847
1848                                                                 let mut hmac = Hmac::new(Sha256::new(), &um);
1849                                                                 hmac.input(&err_packet.encode()[32..]);
1850                                                                 let mut calc_tag = [0u8; 32];
1851                                                                 hmac.raw_result(&mut calc_tag);
1852                                                                 if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
1853                                                                         const UNKNOWN_CHAN: u16 = 0x4000|10;
1854                                                                         const TEMP_CHAN_FAILURE: u16 = 0x4000|7;
1855                                                                         match byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]) {
1856                                                                                 TEMP_CHAN_FAILURE => {
1857                                                                                         if err_packet.failuremsg.len() >= 4 {
1858                                                                                                 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[2..4]) as usize;
1859                                                                                                 if err_packet.failuremsg.len() >= 4 + update_len {
1860                                                                                                         if let Ok(chan_update) = msgs::ChannelUpdate::decode(&err_packet.failuremsg[4..4 + update_len]) {
1861                                                                                                                 res = Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
1862                                                                                                                         msg: chan_update,
1863                                                                                                                 });
1864                                                                                                         }
1865                                                                                                 }
1866                                                                                         }
1867                                                                                 },
1868                                                                                 UNKNOWN_CHAN => {
1869                                                                                         // No such next-hop. We know this came from the
1870                                                                                         // current node as the HMAC validated.
1871                                                                                         res = Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
1872                                                                                                 short_channel_id: route_hop.short_channel_id
1873                                                                                         });
1874                                                                                 },
1875                                                                                 _ => {}, //TODO: Enumerate all of these!
1876                                                                         }
1877                                                                 }
1878                                                         }
1879                                                 }
1880                                         }).unwrap();
1881                                         Ok(res)
1882                                 },
1883                                 _ => { Ok(None) },
1884                         }
1885                 } else {
1886                         Ok(None)
1887                 }
1888         }
1889
1890         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
1891                 let mut channel_state = self.channel_state.lock().unwrap();
1892                 match channel_state.by_id.get_mut(&msg.channel_id) {
1893                         Some(chan) => {
1894                                 if chan.get_their_node_id() != *their_node_id {
1895                                         return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1896                                 }
1897                                 chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() })
1898                         },
1899                         None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1900                 }
1901         }
1902
1903         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option<msgs::CommitmentSigned>), HandleError> {
1904                 let (revoke_and_ack, commitment_signed, chan_monitor) = {
1905                         let mut channel_state = self.channel_state.lock().unwrap();
1906                         match channel_state.by_id.get_mut(&msg.channel_id) {
1907                                 Some(chan) => {
1908                                         if chan.get_their_node_id() != *their_node_id {
1909                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1910                                         }
1911                                         chan.commitment_signed(&msg)?
1912                                 },
1913                                 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1914                         }
1915                 };
1916                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1917                         unimplemented!();
1918                 }
1919
1920                 Ok((revoke_and_ack, commitment_signed))
1921         }
1922
1923         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<Option<msgs::CommitmentUpdate>, HandleError> {
1924                 let (res, mut pending_forwards, mut pending_failures, chan_monitor) = {
1925                         let mut channel_state = self.channel_state.lock().unwrap();
1926                         match channel_state.by_id.get_mut(&msg.channel_id) {
1927                                 Some(chan) => {
1928                                         if chan.get_their_node_id() != *their_node_id {
1929                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1930                                         }
1931                                         chan.revoke_and_ack(&msg)?
1932                                 },
1933                                 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1934                         }
1935                 };
1936                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1937                         unimplemented!();
1938                 }
1939                 for failure in pending_failures.drain(..) {
1940                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), &failure.0, failure.1);
1941                 }
1942
1943                 let mut forward_event = None;
1944                 if !pending_forwards.is_empty() {
1945                         let mut channel_state = self.channel_state.lock().unwrap();
1946                         if channel_state.forward_htlcs.is_empty() {
1947                                 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));
1948                                 channel_state.next_forward = forward_event.unwrap();
1949                         }
1950                         for forward_info in pending_forwards.drain(..) {
1951                                 match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
1952                                         hash_map::Entry::Occupied(mut entry) => {
1953                                                 entry.get_mut().push(forward_info);
1954                                         },
1955                                         hash_map::Entry::Vacant(entry) => {
1956                                                 entry.insert(vec!(forward_info));
1957                                         }
1958                                 }
1959                         }
1960                 }
1961                 match forward_event {
1962                         Some(time) => {
1963                                 let mut pending_events = self.pending_events.lock().unwrap();
1964                                 pending_events.push(events::Event::PendingHTLCsForwardable {
1965                                         time_forwardable: time
1966                                 });
1967                         }
1968                         None => {},
1969                 }
1970
1971                 Ok(res)
1972         }
1973
1974         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
1975                 let mut channel_state = self.channel_state.lock().unwrap();
1976                 match channel_state.by_id.get_mut(&msg.channel_id) {
1977                         Some(chan) => {
1978                                 if chan.get_their_node_id() != *their_node_id {
1979                                         return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1980                                 }
1981                                 chan.update_fee(&*self.fee_estimator, &msg)
1982                         },
1983                         None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
1984                 }
1985         }
1986
1987         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
1988                 let (chan_announcement, chan_update) = {
1989                         let mut channel_state = self.channel_state.lock().unwrap();
1990                         match channel_state.by_id.get_mut(&msg.channel_id) {
1991                                 Some(chan) => {
1992                                         if chan.get_their_node_id() != *their_node_id {
1993                                                 return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None})
1994                                         }
1995                                         if !chan.is_usable() {
1996                                                 return Err(HandleError{err: "Got an announcement_signatures before we were ready for it", action: None });
1997                                         }
1998
1999                                         let our_node_id = self.get_our_node_id();
2000                                         let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone())?;
2001
2002                                         let were_node_one = announcement.node_id_1 == our_node_id;
2003                                         let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
2004                                         secp_call!(self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }));
2005                                         secp_call!(self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }));
2006
2007                                         let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2008
2009                                         (msgs::ChannelAnnouncement {
2010                                                 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2011                                                 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2012                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2013                                                 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2014                                                 contents: announcement,
2015                                         }, self.get_channel_update(chan).unwrap()) // can only fail if we're not in a ready state
2016                                 },
2017                                 None => return Err(HandleError{err: "Failed to find corresponding channel", action: None})
2018                         }
2019                 };
2020                 let mut pending_events = self.pending_events.lock().unwrap();
2021                 pending_events.push(events::Event::BroadcastChannelAnnouncement { msg: chan_announcement, update_msg: chan_update });
2022                 Ok(())
2023         }
2024
2025         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2026                 let mut new_events = Vec::new();
2027                 let mut failed_channels = Vec::new();
2028                 {
2029                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2030                         let channel_state = channel_state_lock.borrow_parts();
2031                         let short_to_id = channel_state.short_to_id;
2032                         if no_connection_possible {
2033                                 channel_state.by_id.retain(|_, chan| {
2034                                         if chan.get_their_node_id() == *their_node_id {
2035                                                 if let Some(short_id) = chan.get_short_channel_id() {
2036                                                         short_to_id.remove(&short_id);
2037                                                 }
2038                                                 failed_channels.push(chan.force_shutdown());
2039                                                 if let Ok(update) = self.get_channel_update(&chan) {
2040                                                         new_events.push(events::Event::BroadcastChannelUpdate {
2041                                                                 msg: update
2042                                                         });
2043                                                 }
2044                                                 false
2045                                         } else {
2046                                                 true
2047                                         }
2048                                 });
2049                         } else {
2050                                 for chan in channel_state.by_id {
2051                                         if chan.1.get_their_node_id() == *their_node_id {
2052                                                 //TODO: mark channel disabled (and maybe announce such after a timeout). Also
2053                                                 //fail and wipe any uncommitted outbound HTLCs as those are considered after
2054                                                 //reconnect.
2055                                         }
2056                                 }
2057                         }
2058                 }
2059                 for failure in failed_channels.drain(..) {
2060                         self.finish_force_close_channel(failure);
2061                 }
2062                 if !new_events.is_empty() {
2063                         let mut pending_events = self.pending_events.lock().unwrap();
2064                         for event in new_events.drain(..) {
2065                                 pending_events.push(event);
2066                         }
2067                 }
2068         }
2069
2070         fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2071                 if msg.channel_id == [0; 32] {
2072                         for chan in self.list_channels() {
2073                                 if chan.remote_network_id == *their_node_id {
2074                                         self.force_close_channel(&chan.channel_id);
2075                                 }
2076                         }
2077                 } else {
2078                         self.force_close_channel(&msg.channel_id);
2079                 }
2080         }
2081 }
2082
2083 #[cfg(test)]
2084 mod tests {
2085         use chain::chaininterface;
2086         use chain::transaction::OutPoint;
2087         use chain::chaininterface::ChainListener;
2088         use ln::channelmanager::{ChannelManager,OnionKeys};
2089         use ln::router::{Route, RouteHop, Router};
2090         use ln::msgs;
2091         use ln::msgs::{MsgEncodable,ChannelMessageHandler,RoutingMessageHandler};
2092         use util::test_utils;
2093         use util::events::{Event, EventsProvider};
2094         use util::logger::Logger;
2095
2096         use bitcoin::util::hash::Sha256dHash;
2097         use bitcoin::blockdata::block::{Block, BlockHeader};
2098         use bitcoin::blockdata::transaction::{Transaction, TxOut};
2099         use bitcoin::network::constants::Network;
2100         use bitcoin::network::serialize::serialize;
2101         use bitcoin::network::serialize::BitcoinHash;
2102
2103         use hex;
2104
2105         use secp256k1::Secp256k1;
2106         use secp256k1::key::{PublicKey,SecretKey};
2107
2108         use crypto::sha2::Sha256;
2109         use crypto::digest::Digest;
2110
2111         use rand::{thread_rng,Rng};
2112
2113         use std::collections::HashMap;
2114         use std::default::Default;
2115         use std::sync::{Arc, Mutex};
2116         use std::time::Instant;
2117         use std::mem;
2118
2119         fn build_test_onion_keys() -> Vec<OnionKeys> {
2120                 // Keys from BOLT 4, used in both test vector tests
2121                 let secp_ctx = Secp256k1::new();
2122
2123                 let route = Route {
2124                         hops: vec!(
2125                                         RouteHop {
2126                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
2127                                                 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
2128                                         },
2129                                         RouteHop {
2130                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
2131                                                 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
2132                                         },
2133                                         RouteHop {
2134                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
2135                                                 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
2136                                         },
2137                                         RouteHop {
2138                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
2139                                                 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
2140                                         },
2141                                         RouteHop {
2142                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
2143                                                 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
2144                                         },
2145                         ),
2146                 };
2147
2148                 let session_priv = SecretKey::from_slice(&secp_ctx, &hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
2149
2150                 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
2151                 assert_eq!(onion_keys.len(), route.hops.len());
2152                 onion_keys
2153         }
2154
2155         #[test]
2156         fn onion_vectors() {
2157                 // Packet creation test vectors from BOLT 4
2158                 let onion_keys = build_test_onion_keys();
2159
2160                 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
2161                 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
2162                 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
2163                 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
2164                 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
2165
2166                 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
2167                 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
2168                 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
2169                 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
2170                 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
2171
2172                 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
2173                 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
2174                 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
2175                 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
2176                 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
2177
2178                 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
2179                 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
2180                 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
2181                 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
2182                 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
2183
2184                 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
2185                 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
2186                 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
2187                 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
2188                 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
2189
2190                 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
2191                 let payloads = vec!(
2192                         msgs::OnionHopData {
2193                                 realm: 0,
2194                                 data: msgs::OnionRealm0HopData {
2195                                         short_channel_id: 0,
2196                                         amt_to_forward: 0,
2197                                         outgoing_cltv_value: 0,
2198                                 },
2199                                 hmac: [0; 32],
2200                         },
2201                         msgs::OnionHopData {
2202                                 realm: 0,
2203                                 data: msgs::OnionRealm0HopData {
2204                                         short_channel_id: 0x0101010101010101,
2205                                         amt_to_forward: 0x0100000001,
2206                                         outgoing_cltv_value: 0,
2207                                 },
2208                                 hmac: [0; 32],
2209                         },
2210                         msgs::OnionHopData {
2211                                 realm: 0,
2212                                 data: msgs::OnionRealm0HopData {
2213                                         short_channel_id: 0x0202020202020202,
2214                                         amt_to_forward: 0x0200000002,
2215                                         outgoing_cltv_value: 0,
2216                                 },
2217                                 hmac: [0; 32],
2218                         },
2219                         msgs::OnionHopData {
2220                                 realm: 0,
2221                                 data: msgs::OnionRealm0HopData {
2222                                         short_channel_id: 0x0303030303030303,
2223                                         amt_to_forward: 0x0300000003,
2224                                         outgoing_cltv_value: 0,
2225                                 },
2226                                 hmac: [0; 32],
2227                         },
2228                         msgs::OnionHopData {
2229                                 realm: 0,
2230                                 data: msgs::OnionRealm0HopData {
2231                                         short_channel_id: 0x0404040404040404,
2232                                         amt_to_forward: 0x0400000004,
2233                                         outgoing_cltv_value: 0,
2234                                 },
2235                                 hmac: [0; 32],
2236                         },
2237                 );
2238
2239                 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, &[0x42; 32]).unwrap();
2240                 // Just check the final packet encoding, as it includes all the per-hop vectors in it
2241                 // anyway...
2242                 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
2243         }
2244
2245         #[test]
2246         fn test_failure_packet_onion() {
2247                 // Returning Errors test vectors from BOLT 4
2248
2249                 let onion_keys = build_test_onion_keys();
2250                 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret, 0x2002, &[0; 0]);
2251                 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
2252
2253                 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret, &onion_error.encode()[..]);
2254                 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
2255
2256                 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret, &onion_packet_1.data[..]);
2257                 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
2258
2259                 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret, &onion_packet_2.data[..]);
2260                 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
2261
2262                 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret, &onion_packet_3.data[..]);
2263                 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
2264
2265                 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret, &onion_packet_4.data[..]);
2266                 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
2267         }
2268
2269         fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
2270                 assert!(chain.does_match_tx(tx));
2271                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2272                 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
2273                 for i in 2..100 {
2274                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2275                         chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
2276                 }
2277         }
2278
2279         struct Node {
2280                 feeest: Arc<test_utils::TestFeeEstimator>,
2281                 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
2282                 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
2283                 chan_monitor: Arc<test_utils::TestChannelMonitor>,
2284                 node: Arc<ChannelManager>,
2285                 router: Router,
2286         }
2287
2288         static mut CHAN_COUNT: u32 = 0;
2289         fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2290                 node_a.node.create_channel(node_b.node.get_our_node_id(), 100000, 10001, 42).unwrap();
2291
2292                 let events_1 = node_a.node.get_and_clear_pending_events();
2293                 assert_eq!(events_1.len(), 1);
2294                 let accept_chan = match events_1[0] {
2295                         Event::SendOpenChannel { ref node_id, ref msg } => {
2296                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
2297                                 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), msg).unwrap()
2298                         },
2299                         _ => panic!("Unexpected event"),
2300                 };
2301
2302                 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &accept_chan).unwrap();
2303
2304                 let chan_id = unsafe { CHAN_COUNT };
2305                 let tx;
2306                 let funding_output;
2307
2308                 let events_2 = node_a.node.get_and_clear_pending_events();
2309                 assert_eq!(events_2.len(), 1);
2310                 match events_2[0] {
2311                         Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
2312                                 assert_eq!(*channel_value_satoshis, 100000);
2313                                 assert_eq!(user_channel_id, 42);
2314
2315                                 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
2316                                         value: *channel_value_satoshis, script_pubkey: output_script.clone(),
2317                                 }]};
2318                                 funding_output = OutPoint::new(Sha256dHash::from_data(&serialize(&tx).unwrap()[..]), 0);
2319
2320                                 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
2321                                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2322                                 assert_eq!(added_monitors.len(), 1);
2323                                 assert_eq!(added_monitors[0].0, funding_output);
2324                                 added_monitors.clear();
2325                         },
2326                         _ => panic!("Unexpected event"),
2327                 }
2328
2329                 let events_3 = node_a.node.get_and_clear_pending_events();
2330                 assert_eq!(events_3.len(), 1);
2331                 let funding_signed = match events_3[0] {
2332                         Event::SendFundingCreated { ref node_id, ref msg } => {
2333                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
2334                                 let res = node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), msg).unwrap();
2335                                 let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
2336                                 assert_eq!(added_monitors.len(), 1);
2337                                 assert_eq!(added_monitors[0].0, funding_output);
2338                                 added_monitors.clear();
2339                                 res
2340                         },
2341                         _ => panic!("Unexpected event"),
2342                 };
2343
2344                 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &funding_signed).unwrap();
2345                 {
2346                         let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2347                         assert_eq!(added_monitors.len(), 1);
2348                         assert_eq!(added_monitors[0].0, funding_output);
2349                         added_monitors.clear();
2350                 }
2351
2352                 let events_4 = node_a.node.get_and_clear_pending_events();
2353                 assert_eq!(events_4.len(), 1);
2354                 match events_4[0] {
2355                         Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
2356                                 assert_eq!(user_channel_id, 42);
2357                                 assert_eq!(*funding_txo, funding_output);
2358                         },
2359                         _ => panic!("Unexpected event"),
2360                 };
2361
2362                 confirm_transaction(&node_a.chain_monitor, &tx, chan_id);
2363                 let events_5 = node_a.node.get_and_clear_pending_events();
2364                 assert_eq!(events_5.len(), 1);
2365                 match events_5[0] {
2366                         Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
2367                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
2368                                 assert!(announcement_sigs.is_none());
2369                                 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), msg).unwrap()
2370                         },
2371                         _ => panic!("Unexpected event"),
2372                 };
2373
2374                 let channel_id;
2375
2376                 confirm_transaction(&node_b.chain_monitor, &tx, chan_id);
2377                 let events_6 = node_b.node.get_and_clear_pending_events();
2378                 assert_eq!(events_6.len(), 1);
2379                 let as_announcement_sigs = match events_6[0] {
2380                         Event::SendFundingLocked { ref node_id, ref msg, ref announcement_sigs } => {
2381                                 assert_eq!(*node_id, node_a.node.get_our_node_id());
2382                                 channel_id = msg.channel_id.clone();
2383                                 let as_announcement_sigs = node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), msg).unwrap().unwrap();
2384                                 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &(*announcement_sigs).clone().unwrap()).unwrap();
2385                                 as_announcement_sigs
2386                         },
2387                         _ => panic!("Unexpected event"),
2388                 };
2389
2390                 let events_7 = node_a.node.get_and_clear_pending_events();
2391                 assert_eq!(events_7.len(), 1);
2392                 let (announcement, as_update) = match events_7[0] {
2393                         Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
2394                                 (msg, update_msg)
2395                         },
2396                         _ => panic!("Unexpected event"),
2397                 };
2398
2399                 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_announcement_sigs).unwrap();
2400                 let events_8 = node_b.node.get_and_clear_pending_events();
2401                 assert_eq!(events_8.len(), 1);
2402                 let bs_update = match events_8[0] {
2403                         Event::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
2404                                 assert!(*announcement == *msg);
2405                                 update_msg
2406                         },
2407                         _ => panic!("Unexpected event"),
2408                 };
2409
2410                 unsafe {
2411                         CHAN_COUNT += 1;
2412                 }
2413
2414                 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone(), channel_id, tx)
2415         }
2416
2417         fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2418                 let chan_announcement = create_chan_between_nodes(&nodes[a], &nodes[b]);
2419                 for node in nodes {
2420                         assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
2421                         node.router.handle_channel_update(&chan_announcement.1).unwrap();
2422                         node.router.handle_channel_update(&chan_announcement.2).unwrap();
2423                 }
2424                 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
2425         }
2426
2427         fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate) {
2428                 let (node_a, broadcaster_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster) } else { (&outbound_node.node, &outbound_node.tx_broadcaster) };
2429                 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
2430                 let (tx_a, tx_b);
2431
2432                 node_a.close_channel(channel_id).unwrap();
2433                 let events_1 = node_a.get_and_clear_pending_events();
2434                 assert_eq!(events_1.len(), 1);
2435                 let shutdown_a = match events_1[0] {
2436                         Event::SendShutdown { ref node_id, ref msg } => {
2437                                 assert_eq!(node_id, &node_b.get_our_node_id());
2438                                 msg.clone()
2439                         },
2440                         _ => panic!("Unexpected event"),
2441                 };
2442
2443                 let (shutdown_b, mut closing_signed_b) = node_b.handle_shutdown(&node_a.get_our_node_id(), &shutdown_a).unwrap();
2444                 if !close_inbound_first {
2445                         assert!(closing_signed_b.is_none());
2446                 }
2447                 let (empty_a, mut closing_signed_a) = node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b.unwrap()).unwrap();
2448                 assert!(empty_a.is_none());
2449                 if close_inbound_first {
2450                         assert!(closing_signed_a.is_none());
2451                         closing_signed_a = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2452                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2453                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2454
2455                         let empty_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2456                         assert!(empty_b.is_none());
2457                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2458                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2459                 } else {
2460                         closing_signed_b = node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
2461                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
2462                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
2463
2464                         let empty_a2 = node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
2465                         assert!(empty_a2.is_none());
2466                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
2467                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
2468                 }
2469                 assert_eq!(tx_a, tx_b);
2470                 let mut funding_tx_map = HashMap::new();
2471                 funding_tx_map.insert(funding_tx.txid(), funding_tx);
2472                 tx_a.verify(&funding_tx_map).unwrap();
2473
2474                 let events_2 = node_a.get_and_clear_pending_events();
2475                 assert_eq!(events_2.len(), 1);
2476                 let as_update = match events_2[0] {
2477                         Event::BroadcastChannelUpdate { ref msg } => {
2478                                 msg.clone()
2479                         },
2480                         _ => panic!("Unexpected event"),
2481                 };
2482
2483                 let events_3 = node_b.get_and_clear_pending_events();
2484                 assert_eq!(events_3.len(), 1);
2485                 let bs_update = match events_3[0] {
2486                         Event::BroadcastChannelUpdate { ref msg } => {
2487                                 msg.clone()
2488                         },
2489                         _ => panic!("Unexpected event"),
2490                 };
2491
2492                 (as_update, bs_update)
2493         }
2494
2495         struct SendEvent {
2496                 node_id: PublicKey,
2497                 msgs: Vec<msgs::UpdateAddHTLC>,
2498                 commitment_msg: msgs::CommitmentSigned,
2499         }
2500         impl SendEvent {
2501                 fn from_event(event: Event) -> SendEvent {
2502                         match event {
2503                                 Event::UpdateHTLCs { node_id, updates: msgs::CommitmentUpdate { update_add_htlcs, update_fulfill_htlcs, update_fail_htlcs, update_fail_malformed_htlcs, commitment_signed } } => {
2504                                         assert!(update_fulfill_htlcs.is_empty());
2505                                         assert!(update_fail_htlcs.is_empty());
2506                                         assert!(update_fail_malformed_htlcs.is_empty());
2507                                         SendEvent { node_id: node_id, msgs: update_add_htlcs, commitment_msg: commitment_signed }
2508                                 },
2509                                 _ => panic!("Unexpected event type!"),
2510                         }
2511                 }
2512         }
2513
2514         static mut PAYMENT_COUNT: u8 = 0;
2515         fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
2516                 let our_payment_preimage = unsafe { [PAYMENT_COUNT; 32] };
2517                 unsafe { PAYMENT_COUNT += 1 };
2518                 let our_payment_hash = {
2519                         let mut sha = Sha256::new();
2520                         sha.input(&our_payment_preimage[..]);
2521                         let mut ret = [0; 32];
2522                         sha.result(&mut ret);
2523                         ret
2524                 };
2525
2526                 let mut payment_event = {
2527                         origin_node.node.send_payment(route, our_payment_hash).unwrap();
2528                         {
2529                                 let mut added_monitors = origin_node.chan_monitor.added_monitors.lock().unwrap();
2530                                 assert_eq!(added_monitors.len(), 1);
2531                                 added_monitors.clear();
2532                         }
2533
2534                         let mut events = origin_node.node.get_and_clear_pending_events();
2535                         assert_eq!(events.len(), 1);
2536                         SendEvent::from_event(events.remove(0))
2537                 };
2538                 let mut prev_node = origin_node;
2539
2540                 for (idx, &node) in expected_route.iter().enumerate() {
2541                         assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
2542
2543                         node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
2544                         {
2545                                 let added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2546                                 assert_eq!(added_monitors.len(), 0);
2547                         }
2548
2549                         let revoke_and_ack = node.node.handle_commitment_signed(&prev_node.node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
2550                         {
2551                                 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2552                                 assert_eq!(added_monitors.len(), 1);
2553                                 added_monitors.clear();
2554                         }
2555                         assert!(prev_node.node.handle_revoke_and_ack(&node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2556                         let prev_revoke_and_ack = prev_node.node.handle_commitment_signed(&node.node.get_our_node_id(), &revoke_and_ack.1.unwrap()).unwrap();
2557                         {
2558                                 let mut added_monitors = prev_node.chan_monitor.added_monitors.lock().unwrap();
2559                                 assert_eq!(added_monitors.len(), 2);
2560                                 added_monitors.clear();
2561                         }
2562                         assert!(node.node.handle_revoke_and_ack(&prev_node.node.get_our_node_id(), &prev_revoke_and_ack.0).unwrap().is_none());
2563                         assert!(prev_revoke_and_ack.1.is_none());
2564                         {
2565                                 let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2566                                 assert_eq!(added_monitors.len(), 1);
2567                                 added_monitors.clear();
2568                         }
2569
2570                         let events_1 = node.node.get_and_clear_pending_events();
2571                         assert_eq!(events_1.len(), 1);
2572                         match events_1[0] {
2573                                 Event::PendingHTLCsForwardable { .. } => { },
2574                                 _ => panic!("Unexpected event"),
2575                         };
2576
2577                         node.node.channel_state.lock().unwrap().next_forward = Instant::now();
2578                         node.node.process_pending_htlc_forwards();
2579
2580                         let mut events_2 = node.node.get_and_clear_pending_events();
2581                         assert_eq!(events_2.len(), 1);
2582                         if idx == expected_route.len() - 1 {
2583                                 match events_2[0] {
2584                                         Event::PaymentReceived { ref payment_hash, amt } => {
2585                                                 assert_eq!(our_payment_hash, *payment_hash);
2586                                                 assert_eq!(amt, recv_value);
2587                                         },
2588                                         _ => panic!("Unexpected event"),
2589                                 }
2590                         } else {
2591                                 {
2592                                         let mut added_monitors = node.chan_monitor.added_monitors.lock().unwrap();
2593                                         assert_eq!(added_monitors.len(), 1);
2594                                         added_monitors.clear();
2595                                 }
2596                                 payment_event = SendEvent::from_event(events_2.remove(0));
2597                                 assert_eq!(payment_event.msgs.len(), 1);
2598                         }
2599
2600                         prev_node = node;
2601                 }
2602
2603                 (our_payment_preimage, our_payment_hash)
2604         }
2605
2606         fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
2607                 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
2608                 {
2609                         let mut added_monitors = expected_route.last().unwrap().chan_monitor.added_monitors.lock().unwrap();
2610                         assert_eq!(added_monitors.len(), 1);
2611                         added_monitors.clear();
2612                 }
2613
2614                 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
2615                 macro_rules! update_fulfill_dance {
2616                         ($node: expr, $prev_node: expr, $last_node: expr) => {
2617                                 {
2618                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2619                                         {
2620                                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2621                                                 if $last_node {
2622                                                         assert_eq!(added_monitors.len(), 0);
2623                                                 } else {
2624                                                         assert_eq!(added_monitors.len(), 1);
2625                                                 }
2626                                                 added_monitors.clear();
2627                                         }
2628                                         let revoke_and_commit = $node.node.handle_commitment_signed(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().1).unwrap();
2629                                         {
2630                                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2631                                                 assert_eq!(added_monitors.len(), 1);
2632                                                 added_monitors.clear();
2633                                         }
2634                                         assert!($prev_node.node.handle_revoke_and_ack(&$node.node.get_our_node_id(), &revoke_and_commit.0).unwrap().is_none());
2635                                         let revoke_and_ack = $prev_node.node.handle_commitment_signed(&$node.node.get_our_node_id(), &revoke_and_commit.1.unwrap()).unwrap();
2636                                         assert!(revoke_and_ack.1.is_none());
2637                                         {
2638                                                 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2639                                                 assert_eq!(added_monitors.len(), 2);
2640                                                 added_monitors.clear();
2641                                         }
2642                                         assert!($node.node.handle_revoke_and_ack(&$prev_node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2643                                         {
2644                                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2645                                                 assert_eq!(added_monitors.len(), 1);
2646                                                 added_monitors.clear();
2647                                         }
2648                                 }
2649                         }
2650                 }
2651
2652                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2653                 let mut prev_node = expected_route.last().unwrap();
2654                 for node in expected_route.iter().rev() {
2655                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2656                         if next_msgs.is_some() {
2657                                 update_fulfill_dance!(node, prev_node, false);
2658                         }
2659
2660                         let events = node.node.get_and_clear_pending_events();
2661                         assert_eq!(events.len(), 1);
2662                         match events[0] {
2663                                 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 commitment_signed } } => {
2664                                         assert!(update_add_htlcs.is_empty());
2665                                         assert_eq!(update_fulfill_htlcs.len(), 1);
2666                                         assert!(update_fail_htlcs.is_empty());
2667                                         assert!(update_fail_malformed_htlcs.is_empty());
2668                                         expected_next_node = node_id.clone();
2669                                         next_msgs = Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()));
2670                                 },
2671                                 _ => panic!("Unexpected event"),
2672                         };
2673
2674                         prev_node = node;
2675                 }
2676
2677                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2678                 update_fulfill_dance!(origin_node, expected_route.first().unwrap(), true);
2679
2680                 let events = origin_node.node.get_and_clear_pending_events();
2681                 assert_eq!(events.len(), 1);
2682                 match events[0] {
2683                         Event::PaymentSent { payment_preimage } => {
2684                                 assert_eq!(payment_preimage, our_payment_preimage);
2685                         },
2686                         _ => panic!("Unexpected event"),
2687                 }
2688         }
2689
2690         const TEST_FINAL_CLTV: u32 = 32;
2691
2692         fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
2693                 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();
2694                 assert_eq!(route.hops.len(), expected_route.len());
2695                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2696                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
2697                 }
2698
2699                 send_along_route(origin_node, route, expected_route, recv_value)
2700         }
2701
2702         fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
2703                 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();
2704                 assert_eq!(route.hops.len(), expected_route.len());
2705                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
2706                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
2707                 }
2708
2709                 let our_payment_preimage = unsafe { [PAYMENT_COUNT; 32] };
2710                 unsafe { PAYMENT_COUNT += 1 };
2711                 let our_payment_hash = {
2712                         let mut sha = Sha256::new();
2713                         sha.input(&our_payment_preimage[..]);
2714                         let mut ret = [0; 32];
2715                         sha.result(&mut ret);
2716                         ret
2717                 };
2718
2719                 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
2720                 assert_eq!(err.err, "Cannot send value that would put us over our max HTLC value in flight");
2721         }
2722
2723         fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
2724                 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
2725                 claim_payment(&origin, expected_route, our_payment_preimage);
2726         }
2727
2728         fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
2729                 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash));
2730                 {
2731                         let mut added_monitors = expected_route.last().unwrap().chan_monitor.added_monitors.lock().unwrap();
2732                         assert_eq!(added_monitors.len(), 1);
2733                         added_monitors.clear();
2734                 }
2735
2736                 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
2737                 macro_rules! update_fail_dance {
2738                         ($node: expr, $prev_node: expr, $last_node: expr) => {
2739                                 {
2740                                         $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
2741                                         let revoke_and_commit = $node.node.handle_commitment_signed(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().1).unwrap();
2742
2743                                         {
2744                                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2745                                                 assert_eq!(added_monitors.len(), 1);
2746                                                 added_monitors.clear();
2747                                         }
2748                                         assert!($prev_node.node.handle_revoke_and_ack(&$node.node.get_our_node_id(), &revoke_and_commit.0).unwrap().is_none());
2749                                         {
2750                                                 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2751                                                 assert_eq!(added_monitors.len(), 1);
2752                                                 added_monitors.clear();
2753                                         }
2754                                         let revoke_and_ack = $prev_node.node.handle_commitment_signed(&$node.node.get_our_node_id(), &revoke_and_commit.1.unwrap()).unwrap();
2755                                         {
2756                                                 let mut added_monitors = $prev_node.chan_monitor.added_monitors.lock().unwrap();
2757                                                 assert_eq!(added_monitors.len(), 1);
2758                                                 added_monitors.clear();
2759                                         }
2760                                         assert!(revoke_and_ack.1.is_none());
2761                                         assert!($node.node.get_and_clear_pending_events().is_empty());
2762                                         assert!($node.node.handle_revoke_and_ack(&$prev_node.node.get_our_node_id(), &revoke_and_ack.0).unwrap().is_none());
2763                                         {
2764                                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
2765                                                 if $last_node {
2766                                                         assert_eq!(added_monitors.len(), 1);
2767                                                 } else {
2768                                                         assert_eq!(added_monitors.len(), 2);
2769                                                         assert!(added_monitors[0].0 != added_monitors[1].0);
2770                                                 }
2771                                                 added_monitors.clear();
2772                                         }
2773                                 }
2774                         }
2775                 }
2776
2777                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
2778                 let mut prev_node = expected_route.last().unwrap();
2779                 for node in expected_route.iter().rev() {
2780                         assert_eq!(expected_next_node, node.node.get_our_node_id());
2781                         if next_msgs.is_some() {
2782                                 update_fail_dance!(node, prev_node, false);
2783                         }
2784
2785                         let events = node.node.get_and_clear_pending_events();
2786                         assert_eq!(events.len(), 1);
2787                         match events[0] {
2788                                 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 commitment_signed } } => {
2789                                         assert!(update_add_htlcs.is_empty());
2790                                         assert!(update_fulfill_htlcs.is_empty());
2791                                         assert_eq!(update_fail_htlcs.len(), 1);
2792                                         assert!(update_fail_malformed_htlcs.is_empty());
2793                                         expected_next_node = node_id.clone();
2794                                         next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
2795                                 },
2796                                 _ => panic!("Unexpected event"),
2797                         };
2798
2799                         prev_node = node;
2800                 }
2801
2802                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
2803                 update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
2804
2805                 let events = origin_node.node.get_and_clear_pending_events();
2806                 assert_eq!(events.len(), 1);
2807                 match events[0] {
2808                         Event::PaymentFailed { payment_hash } => {
2809                                 assert_eq!(payment_hash, our_payment_hash);
2810                         },
2811                         _ => panic!("Unexpected event"),
2812                 }
2813         }
2814
2815         fn create_network(node_count: usize) -> Vec<Node> {
2816                 let mut nodes = Vec::new();
2817                 let mut rng = thread_rng();
2818                 let secp_ctx = Secp256k1::new();
2819                 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
2820
2821                 for _ in 0..node_count {
2822                         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
2823                         let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Arc::clone(&logger)));
2824                         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
2825                         let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone()));
2826                         let node_id = {
2827                                 let mut key_slice = [0; 32];
2828                                 rng.fill_bytes(&mut key_slice);
2829                                 SecretKey::from_slice(&secp_ctx, &key_slice).unwrap()
2830                         };
2831                         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();
2832                         let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &node_id), Arc::clone(&logger));
2833                         nodes.push(Node { feeest, chain_monitor, tx_broadcaster, chan_monitor, node, router });
2834                 }
2835
2836                 nodes
2837         }
2838
2839         #[test]
2840         fn fake_network_test() {
2841                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
2842                 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
2843                 let nodes = create_network(4);
2844
2845                 // Create some initial channels
2846                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
2847                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
2848                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
2849
2850                 // Rebalance the network a bit by relaying one payment through all the channels...
2851                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2852                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2853                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2854                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
2855
2856                 // Send some more payments
2857                 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
2858                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
2859                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
2860
2861                 // Test failure packets
2862                 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
2863                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
2864
2865                 // Add a new channel that skips 3
2866                 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
2867
2868                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
2869                 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
2870                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2871                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2872                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2873                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2874                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
2875
2876                 // Do some rebalance loop payments, simultaneously
2877                 let mut hops = Vec::with_capacity(3);
2878                 hops.push(RouteHop {
2879                         pubkey: nodes[2].node.get_our_node_id(),
2880                         short_channel_id: chan_2.0.contents.short_channel_id,
2881                         fee_msat: 0,
2882                         cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
2883                 });
2884                 hops.push(RouteHop {
2885                         pubkey: nodes[3].node.get_our_node_id(),
2886                         short_channel_id: chan_3.0.contents.short_channel_id,
2887                         fee_msat: 0,
2888                         cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
2889                 });
2890                 hops.push(RouteHop {
2891                         pubkey: nodes[1].node.get_our_node_id(),
2892                         short_channel_id: chan_4.0.contents.short_channel_id,
2893                         fee_msat: 1000000,
2894                         cltv_expiry_delta: TEST_FINAL_CLTV,
2895                 });
2896                 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;
2897                 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;
2898                 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
2899
2900                 let mut hops = Vec::with_capacity(3);
2901                 hops.push(RouteHop {
2902                         pubkey: nodes[3].node.get_our_node_id(),
2903                         short_channel_id: chan_4.0.contents.short_channel_id,
2904                         fee_msat: 0,
2905                         cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
2906                 });
2907                 hops.push(RouteHop {
2908                         pubkey: nodes[2].node.get_our_node_id(),
2909                         short_channel_id: chan_3.0.contents.short_channel_id,
2910                         fee_msat: 0,
2911                         cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
2912                 });
2913                 hops.push(RouteHop {
2914                         pubkey: nodes[1].node.get_our_node_id(),
2915                         short_channel_id: chan_2.0.contents.short_channel_id,
2916                         fee_msat: 1000000,
2917                         cltv_expiry_delta: TEST_FINAL_CLTV,
2918                 });
2919                 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;
2920                 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;
2921                 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
2922
2923                 // Claim the rebalances...
2924                 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
2925                 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
2926
2927                 // Add a duplicate new channel from 2 to 4
2928                 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
2929
2930                 // Send some payments across both channels
2931                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2932                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2933                 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
2934
2935                 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
2936
2937                 //TODO: Test that routes work again here as we've been notified that the channel is full
2938
2939                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
2940                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
2941                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
2942
2943                 // Close down the channels...
2944                 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
2945                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
2946                 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
2947                 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
2948                 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
2949
2950                 // Check that we processed all pending events
2951                 for node in nodes {
2952                         assert_eq!(node.node.get_and_clear_pending_events().len(), 0);
2953                         assert_eq!(node.chan_monitor.added_monitors.lock().unwrap().len(), 0);
2954                 }
2955         }
2956
2957         #[derive(PartialEq)]
2958         enum HTLCType { NONE, TIMEOUT, SUCCESS }
2959         fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
2960                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
2961                 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
2962
2963                 let mut res = Vec::with_capacity(2);
2964
2965                 if let Some(explicit_tx) = commitment_tx {
2966                         res.push(explicit_tx.clone());
2967                 } else {
2968                         for tx in node_txn.iter() {
2969                                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
2970                                         let mut funding_tx_map = HashMap::new();
2971                                         funding_tx_map.insert(chan.3.txid(), chan.3.clone());
2972                                         tx.verify(&funding_tx_map).unwrap();
2973                                         res.push(tx.clone());
2974                                 }
2975                         }
2976                 }
2977                 assert_eq!(res.len(), 1);
2978
2979                 if has_htlc_tx != HTLCType::NONE {
2980                         for tx in node_txn.iter() {
2981                                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
2982                                         let mut funding_tx_map = HashMap::new();
2983                                         funding_tx_map.insert(res[0].txid(), res[0].clone());
2984                                         tx.verify(&funding_tx_map).unwrap();
2985                                         if has_htlc_tx == HTLCType::TIMEOUT {
2986                                                 assert!(tx.lock_time != 0);
2987                                         } else {
2988                                                 assert!(tx.lock_time == 0);
2989                                         }
2990                                         res.push(tx.clone());
2991                                         break;
2992                                 }
2993                         }
2994                         assert_eq!(res.len(), 2);
2995                 }
2996                 node_txn.clear();
2997                 res
2998         }
2999
3000         fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
3001                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
3002
3003                 assert!(node_txn.len() >= 1);
3004                 assert_eq!(node_txn[0].input.len(), 1);
3005                 let mut found_prev = false;
3006
3007                 for tx in prev_txn {
3008                         if node_txn[0].input[0].previous_output.txid == tx.txid() {
3009                                 let mut funding_tx_map = HashMap::new();
3010                                 funding_tx_map.insert(tx.txid(), tx.clone());
3011                                 node_txn[0].verify(&funding_tx_map).unwrap();
3012
3013                                 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
3014                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
3015
3016                                 found_prev = true;
3017                                 break;
3018                         }
3019                 }
3020                 assert!(found_prev);
3021
3022                 let mut res = Vec::new();
3023                 mem::swap(&mut *node_txn, &mut res);
3024                 res
3025         }
3026
3027         fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
3028                 let events_1 = nodes[a].node.get_and_clear_pending_events();
3029                 assert_eq!(events_1.len(), 1);
3030                 let as_update = match events_1[0] {
3031                         Event::BroadcastChannelUpdate { ref msg } => {
3032                                 msg.clone()
3033                         },
3034                         _ => panic!("Unexpected event"),
3035                 };
3036
3037                 let events_2 = nodes[b].node.get_and_clear_pending_events();
3038                 assert_eq!(events_2.len(), 1);
3039                 let bs_update = match events_2[0] {
3040                         Event::BroadcastChannelUpdate { ref msg } => {
3041                                 msg.clone()
3042                         },
3043                         _ => panic!("Unexpected event"),
3044                 };
3045
3046                 for node in nodes {
3047                         node.router.handle_channel_update(&as_update).unwrap();
3048                         node.router.handle_channel_update(&bs_update).unwrap();
3049                 }
3050         }
3051
3052         #[test]
3053         fn channel_monitor_network_test() {
3054                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
3055                 // tests that ChannelMonitor is able to recover from various states.
3056                 let nodes = create_network(5);
3057
3058                 // Create some initial channels
3059                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
3060                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
3061                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
3062                 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
3063
3064                 // Rebalance the network a bit by relaying one payment through all the channels...
3065                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
3066                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
3067                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
3068                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
3069
3070                 // Simple case with no pending HTLCs:
3071                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
3072                 {
3073                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
3074                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3075                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
3076                         test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
3077                 }
3078                 get_announce_close_broadcast_events(&nodes, 0, 1);
3079                 assert_eq!(nodes[0].node.list_channels().len(), 0);
3080                 assert_eq!(nodes[1].node.list_channels().len(), 1);
3081
3082                 // One pending HTLC is discarded by the force-close:
3083                 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
3084
3085                 // Simple case of one pending HTLC to HTLC-Timeout
3086                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
3087                 {
3088                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
3089                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3090                         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
3091                         test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
3092                 }
3093                 get_announce_close_broadcast_events(&nodes, 1, 2);
3094                 assert_eq!(nodes[1].node.list_channels().len(), 0);
3095                 assert_eq!(nodes[2].node.list_channels().len(), 1);
3096
3097                 macro_rules! claim_funds {
3098                         ($node: expr, $prev_node: expr, $preimage: expr) => {
3099                                 {
3100                                         assert!($node.node.claim_funds($preimage));
3101                                         {
3102                                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
3103                                                 assert_eq!(added_monitors.len(), 1);
3104                                                 added_monitors.clear();
3105                                         }
3106
3107                                         let events = $node.node.get_and_clear_pending_events();
3108                                         assert_eq!(events.len(), 1);
3109                                         match events[0] {
3110                                                 Event::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
3111                                                         assert!(update_add_htlcs.is_empty());
3112                                                         assert!(update_fail_htlcs.is_empty());
3113                                                         assert_eq!(*node_id, $prev_node.node.get_our_node_id());
3114                                                 },
3115                                                 _ => panic!("Unexpected event"),
3116                                         };
3117                                 }
3118                         }
3119                 }
3120
3121                 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
3122                 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
3123                 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
3124                 {
3125                         let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
3126
3127                         // Claim the payment on nodes[3], giving it knowledge of the preimage
3128                         claim_funds!(nodes[3], nodes[2], payment_preimage_1);
3129
3130                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3131                         nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
3132
3133                         check_preimage_claim(&nodes[3], &node_txn);
3134                 }
3135                 get_announce_close_broadcast_events(&nodes, 2, 3);
3136                 assert_eq!(nodes[2].node.list_channels().len(), 0);
3137                 assert_eq!(nodes[3].node.list_channels().len(), 1);
3138
3139                 // One pending HTLC to time out:
3140                 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
3141
3142                 {
3143                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3144                         nodes[3].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
3145                         for i in 2..TEST_FINAL_CLTV - 3 {
3146                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3147                                 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
3148                         }
3149
3150                         let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
3151
3152                         // Claim the payment on nodes[3], giving it knowledge of the preimage
3153                         claim_funds!(nodes[4], nodes[3], payment_preimage_2);
3154
3155                         header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3156                         nodes[4].chain_monitor.block_connected_checked(&header, 1, &Vec::new()[..], &[0; 0]);
3157                         for i in 2..TEST_FINAL_CLTV - 3 {
3158                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3159                                 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
3160                         }
3161
3162                         test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
3163
3164                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3165                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
3166
3167                         check_preimage_claim(&nodes[4], &node_txn);
3168                 }
3169                 get_announce_close_broadcast_events(&nodes, 3, 4);
3170                 assert_eq!(nodes[3].node.list_channels().len(), 0);
3171                 assert_eq!(nodes[4].node.list_channels().len(), 0);
3172
3173                 // Create some new channels:
3174                 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
3175
3176                 // A pending HTLC which will be revoked:
3177                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
3178                 // Get the will-be-revoked local txn from nodes[0]
3179                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
3180                 // Revoke the old state
3181                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
3182
3183                 {
3184                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3185                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3186                         {
3187                                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
3188                                 assert_eq!(node_txn.len(), 2);
3189                                 assert_eq!(node_txn[0].input.len(), 1);
3190
3191                                 let mut funding_tx_map = HashMap::new();
3192                                 funding_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
3193                                 node_txn[0].verify(&funding_tx_map).unwrap();
3194                                 node_txn.swap_remove(0);
3195                         }
3196                         test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
3197
3198                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
3199                         let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
3200                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3201                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
3202
3203                         //TODO: At this point nodes[1] should claim the revoked HTLC-Timeout output, but that's
3204                         //not yet implemented in ChannelMonitor
3205                 }
3206                 get_announce_close_broadcast_events(&nodes, 0, 1);
3207                 assert_eq!(nodes[0].node.list_channels().len(), 0);
3208                 assert_eq!(nodes[1].node.list_channels().len(), 0);
3209
3210                 // Check that we processed all pending events
3211                 for node in nodes {
3212                         assert_eq!(node.node.get_and_clear_pending_events().len(), 0);
3213                         assert_eq!(node.chan_monitor.added_monitors.lock().unwrap().len(), 0);
3214                 }
3215         }
3216
3217         #[test]
3218         fn test_unconf_chan() {
3219                 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
3220                 let nodes = create_network(2);
3221                 create_announced_chan_between_nodes(&nodes, 0, 1);
3222
3223                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3224                 assert_eq!(channel_state.by_id.len(), 1);
3225                 assert_eq!(channel_state.short_to_id.len(), 1);
3226                 mem::drop(channel_state);
3227
3228                 let mut headers = Vec::new();
3229                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3230                 headers.push(header.clone());
3231                 for _i in 2..100 {
3232                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3233                         headers.push(header.clone());
3234                 }
3235                 while !headers.is_empty() {
3236                         nodes[0].node.block_disconnected(&headers.pop().unwrap());
3237                 }
3238                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
3239                 assert_eq!(channel_state.by_id.len(), 0);
3240                 assert_eq!(channel_state.short_to_id.len(), 0);
3241         }
3242 }