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