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