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