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