]> git.bitcoin.ninja Git - rust-lightning/blob - src/ln/channelmanager.rs
Send RAA/CS messages out-of-band to ensure ordered delivery
[rust-lightning] / src / ln / channelmanager.rs
1 //! The top-level channel management and payment tracking stuff lives here.
2 //!
3 //! The ChannelManager is the main chunk of logic implementing the lightning protocol and is
4 //! responsible for tracking which channels are open, HTLCs are in flight and reestablishing those
5 //! upon reconnect to the relevant peer(s).
6 //!
7 //! It does not manage routing logic (see ln::router for that) nor does it manage constructing
8 //! on-chain transactions (it only monitors the chain to watch for any force-closes that might
9 //! imply it needs to fail HTLCs/payments/channels it manages).
10
11 use bitcoin::blockdata::block::BlockHeader;
12 use bitcoin::blockdata::transaction::Transaction;
13 use bitcoin::blockdata::constants::genesis_block;
14 use bitcoin::network::constants::Network;
15 use bitcoin::network::serialize::BitcoinHash;
16 use bitcoin::util::hash::Sha256dHash;
17
18 use secp256k1::key::{SecretKey,PublicKey};
19 use secp256k1::{Secp256k1,Message};
20 use secp256k1::ecdh::SharedSecret;
21 use secp256k1;
22
23 use chain::chaininterface::{BroadcasterInterface,ChainListener,ChainWatchInterface,FeeEstimator};
24 use chain::transaction::OutPoint;
25 use ln::channel::{Channel, ChannelError};
26 use ln::channelmonitor::{ChannelMonitorUpdateErr, ManyChannelMonitor, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS};
27 use ln::router::{Route,RouteHop};
28 use ln::msgs;
29 use ln::msgs::{ChannelMessageHandler, HandleError, RAACommitmentOrder};
30 use chain::keysinterface::KeysInterface;
31 use util::{byte_utils, events, internal_traits, rng};
32 use util::sha2::Sha256;
33 use util::ser::{Readable, Writeable};
34 use util::chacha20poly1305rfc::ChaCha20;
35 use util::logger::Logger;
36 use util::errors::APIError;
37
38 use crypto;
39 use crypto::mac::{Mac,MacResult};
40 use crypto::hmac::Hmac;
41 use crypto::digest::Digest;
42 use crypto::symmetriccipher::SynchronousStreamCipher;
43
44 use std::{ptr, mem};
45 use std::collections::HashMap;
46 use std::collections::hash_map;
47 use std::io::Cursor;
48 use std::sync::{Mutex,MutexGuard,Arc};
49 use std::sync::atomic::{AtomicUsize, Ordering};
50 use std::time::{Instant,Duration};
51
52 /// We hold various information about HTLC relay in the HTLC objects in Channel itself:
53 ///
54 /// Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
55 /// forward the HTLC with information it will give back to us when it does so, or if it should Fail
56 /// the HTLC with the relevant message for the Channel to handle giving to the remote peer.
57 ///
58 /// When a Channel forwards an HTLC to its peer, it will give us back the PendingForwardHTLCInfo
59 /// which we will use to construct an outbound HTLC, with a relevant HTLCSource::PreviousHopData
60 /// filled in to indicate where it came from (which we can use to either fail-backwards or fulfill
61 /// the HTLC backwards along the relevant path).
62 /// Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
63 /// our payment, which we can use to decode errors or inform the user that the payment was sent.
64 mod channel_held_info {
65         use ln::msgs;
66         use ln::router::Route;
67         use secp256k1::key::SecretKey;
68         use secp256k1::ecdh::SharedSecret;
69
70         /// Stores the info we will need to send when we want to forward an HTLC onwards
71         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
72         pub struct PendingForwardHTLCInfo {
73                 pub(super) onion_packet: Option<msgs::OnionPacket>,
74                 pub(super) incoming_shared_secret: SharedSecret,
75                 pub(super) payment_hash: [u8; 32],
76                 pub(super) short_channel_id: u64,
77                 pub(super) amt_to_forward: u64,
78                 pub(super) outgoing_cltv_value: u32,
79         }
80
81         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
82         pub enum HTLCFailureMsg {
83                 Relay(msgs::UpdateFailHTLC),
84                 Malformed(msgs::UpdateFailMalformedHTLC),
85         }
86
87         /// Stores whether we can't forward an HTLC or relevant forwarding info
88         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
89         pub enum PendingHTLCStatus {
90                 Forward(PendingForwardHTLCInfo),
91                 Fail(HTLCFailureMsg),
92         }
93
94         /// Tracks the inbound corresponding to an outbound HTLC
95         #[derive(Clone)]
96         pub struct HTLCPreviousHopData {
97                 pub(super) short_channel_id: u64,
98                 pub(super) htlc_id: u64,
99                 pub(super) incoming_packet_shared_secret: SharedSecret,
100         }
101
102         /// Tracks the inbound corresponding to an outbound HTLC
103         #[derive(Clone)]
104         pub enum HTLCSource {
105                 PreviousHopData(HTLCPreviousHopData),
106                 OutboundRoute {
107                         route: Route,
108                         session_priv: SecretKey,
109                         /// Technically we can recalculate this from the route, but we cache it here to avoid
110                         /// doing a double-pass on route when we get a failure back
111                         first_hop_htlc_msat: u64,
112                 },
113         }
114         #[cfg(test)]
115         impl HTLCSource {
116                 pub fn dummy() -> Self {
117                         HTLCSource::OutboundRoute {
118                                 route: Route { hops: Vec::new() },
119                                 session_priv: SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[1; 32]).unwrap(),
120                                 first_hop_htlc_msat: 0,
121                         }
122                 }
123         }
124
125         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
126         pub(crate) enum HTLCFailReason {
127                 ErrorPacket {
128                         err: msgs::OnionErrorPacket,
129                 },
130                 Reason {
131                         failure_code: u16,
132                         data: Vec<u8>,
133                 }
134         }
135 }
136 pub(super) use self::channel_held_info::*;
137
138 struct MsgHandleErrInternal {
139         err: msgs::HandleError,
140         needs_channel_force_close: bool,
141 }
142 impl MsgHandleErrInternal {
143         #[inline]
144         fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
145                 Self {
146                         err: HandleError {
147                                 err,
148                                 action: Some(msgs::ErrorAction::SendErrorMessage {
149                                         msg: msgs::ErrorMessage {
150                                                 channel_id,
151                                                 data: err.to_string()
152                                         },
153                                 }),
154                         },
155                         needs_channel_force_close: false,
156                 }
157         }
158         #[inline]
159         fn send_err_msg_close_chan(err: &'static str, channel_id: [u8; 32]) -> Self {
160                 Self {
161                         err: HandleError {
162                                 err,
163                                 action: Some(msgs::ErrorAction::SendErrorMessage {
164                                         msg: msgs::ErrorMessage {
165                                                 channel_id,
166                                                 data: err.to_string()
167                                         },
168                                 }),
169                         },
170                         needs_channel_force_close: true,
171                 }
172         }
173         #[inline]
174         fn from_maybe_close(err: msgs::HandleError) -> Self {
175                 Self { err, needs_channel_force_close: true }
176         }
177         #[inline]
178         fn from_no_close(err: msgs::HandleError) -> Self {
179                 Self { err, needs_channel_force_close: false }
180         }
181         #[inline]
182         fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
183                 Self {
184                         err: match err {
185                                 ChannelError::Ignore(msg) => HandleError {
186                                         err: msg,
187                                         action: Some(msgs::ErrorAction::IgnoreError),
188                                 },
189                                 ChannelError::Close(msg) => HandleError {
190                                         err: msg,
191                                         action: Some(msgs::ErrorAction::SendErrorMessage {
192                                                 msg: msgs::ErrorMessage {
193                                                         channel_id,
194                                                         data: msg.to_string()
195                                                 },
196                                         }),
197                                 },
198                         },
199                         needs_channel_force_close: false,
200                 }
201         }
202         #[inline]
203         fn from_chan_maybe_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
204                 Self {
205                         err: match err {
206                                 ChannelError::Ignore(msg) => HandleError {
207                                         err: msg,
208                                         action: Some(msgs::ErrorAction::IgnoreError),
209                                 },
210                                 ChannelError::Close(msg) => HandleError {
211                                         err: msg,
212                                         action: Some(msgs::ErrorAction::SendErrorMessage {
213                                                 msg: msgs::ErrorMessage {
214                                                         channel_id,
215                                                         data: msg.to_string()
216                                                 },
217                                         }),
218                                 },
219                         },
220                         needs_channel_force_close: true,
221                 }
222         }
223 }
224
225 /// Pass to fail_htlc_backwwards to indicate the reason to fail the payment
226 /// after a PaymentReceived event.
227 #[derive(PartialEq)]
228 pub enum PaymentFailReason {
229         /// Indicate the preimage for payment_hash is not known after a PaymentReceived event
230         PreimageUnknown,
231         /// Indicate the payment amount is incorrect ( received is < expected or > 2*expected ) after a PaymentReceived event
232         AmountMismatch,
233 }
234
235 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
236 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
237 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
238 /// probably increase this significantly.
239 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
240
241 struct HTLCForwardInfo {
242         prev_short_channel_id: u64,
243         prev_htlc_id: u64,
244         forward_info: PendingForwardHTLCInfo,
245 }
246
247 struct ChannelHolder {
248         by_id: HashMap<[u8; 32], Channel>,
249         short_to_id: HashMap<u64, [u8; 32]>,
250         next_forward: Instant,
251         /// short channel id -> forward infos. Key of 0 means payments received
252         /// Note that while this is held in the same mutex as the channels themselves, no consistency
253         /// guarantees are made about there existing a channel with the short id here, nor the short
254         /// ids in the PendingForwardHTLCInfo!
255         forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
256         /// Note that while this is held in the same mutex as the channels themselves, no consistency
257         /// guarantees are made about the channels given here actually existing anymore by the time you
258         /// go to read them!
259         claimable_htlcs: HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
260         /// Messages to send to peers - pushed to in the same lock that they are generated in (except
261         /// for broadcast messages, where ordering isn't as strict).
262         pending_msg_events: Vec<events::MessageSendEvent>,
263 }
264 struct MutChannelHolder<'a> {
265         by_id: &'a mut HashMap<[u8; 32], Channel>,
266         short_to_id: &'a mut HashMap<u64, [u8; 32]>,
267         next_forward: &'a mut Instant,
268         forward_htlcs: &'a mut HashMap<u64, Vec<HTLCForwardInfo>>,
269         claimable_htlcs: &'a mut HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
270         pending_msg_events: &'a mut Vec<events::MessageSendEvent>,
271 }
272 impl ChannelHolder {
273         fn borrow_parts(&mut self) -> MutChannelHolder {
274                 MutChannelHolder {
275                         by_id: &mut self.by_id,
276                         short_to_id: &mut self.short_to_id,
277                         next_forward: &mut self.next_forward,
278                         forward_htlcs: &mut self.forward_htlcs,
279                         claimable_htlcs: &mut self.claimable_htlcs,
280                         pending_msg_events: &mut self.pending_msg_events,
281                 }
282         }
283 }
284
285 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
286 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
287
288 /// Manager which keeps track of a number of channels and sends messages to the appropriate
289 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
290 ///
291 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
292 /// to individual Channels.
293 pub struct ChannelManager {
294         genesis_hash: Sha256dHash,
295         fee_estimator: Arc<FeeEstimator>,
296         monitor: Arc<ManyChannelMonitor>,
297         chain_monitor: Arc<ChainWatchInterface>,
298         tx_broadcaster: Arc<BroadcasterInterface>,
299
300         announce_channels_publicly: bool,
301         fee_proportional_millionths: u32,
302         latest_block_height: AtomicUsize,
303         secp_ctx: Secp256k1<secp256k1::All>,
304
305         channel_state: Mutex<ChannelHolder>,
306         our_network_key: SecretKey,
307
308         pending_events: Mutex<Vec<events::Event>>,
309
310         keys_manager: Arc<KeysInterface>,
311
312         logger: Arc<Logger>,
313 }
314
315 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
316 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
317 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
318 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
319 /// CLTV_CLAIM_BUFFER point (we static assert that its at least 3 blocks more).
320 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
321 const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
322
323 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + 2*HTLC_FAIL_TIMEOUT_BLOCKS, ie that
324 // if the next-hop peer fails the HTLC within HTLC_FAIL_TIMEOUT_BLOCKS then we'll still have
325 // HTLC_FAIL_TIMEOUT_BLOCKS left to fail it backwards ourselves before hitting the
326 // CLTV_CLAIM_BUFFER point and failing the channel on-chain to time out the HTLC.
327 #[deny(const_err)]
328 #[allow(dead_code)]
329 const CHECK_CLTV_EXPIRY_SANITY: u32 = CLTV_EXPIRY_DELTA as u32 - 2*HTLC_FAIL_TIMEOUT_BLOCKS - CLTV_CLAIM_BUFFER;
330
331 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
332 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
333 #[deny(const_err)]
334 #[allow(dead_code)]
335 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - HTLC_FAIL_TIMEOUT_BLOCKS - 2*CLTV_CLAIM_BUFFER;
336
337 macro_rules! secp_call {
338         ( $res: expr, $err: expr ) => {
339                 match $res {
340                         Ok(key) => key,
341                         Err(_) => return Err($err),
342                 }
343         };
344 }
345
346 struct OnionKeys {
347         #[cfg(test)]
348         shared_secret: SharedSecret,
349         #[cfg(test)]
350         blinding_factor: [u8; 32],
351         ephemeral_pubkey: PublicKey,
352         rho: [u8; 32],
353         mu: [u8; 32],
354 }
355
356 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
357 pub struct ChannelDetails {
358         /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
359         /// thereafter this is the txid of the funding transaction xor the funding transaction output).
360         /// Note that this means this value is *not* persistent - it can change once during the
361         /// lifetime of the channel.
362         pub channel_id: [u8; 32],
363         /// The position of the funding transaction in the chain. None if the funding transaction has
364         /// not yet been confirmed and the channel fully opened.
365         pub short_channel_id: Option<u64>,
366         /// The node_id of our counterparty
367         pub remote_network_id: PublicKey,
368         /// The value, in satoshis, of this channel as appears in the funding output
369         pub channel_value_satoshis: u64,
370         /// The user_id passed in to create_channel, or 0 if the channel was inbound.
371         pub user_id: u64,
372 }
373
374 impl ChannelManager {
375         /// Constructs a new ChannelManager to hold several channels and route between them.
376         ///
377         /// This is the main "logic hub" for all channel-related actions, and implements
378         /// ChannelMessageHandler.
379         ///
380         /// fee_proportional_millionths is an optional fee to charge any payments routed through us.
381         /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
382         ///
383         /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
384         pub fn new(fee_proportional_millionths: u32, announce_channels_publicly: bool, network: Network, feeest: Arc<FeeEstimator>, monitor: Arc<ManyChannelMonitor>, chain_monitor: Arc<ChainWatchInterface>, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>, keys_manager: Arc<KeysInterface>) -> Result<Arc<ChannelManager>, secp256k1::Error> {
385                 let secp_ctx = Secp256k1::new();
386
387                 let res = Arc::new(ChannelManager {
388                         genesis_hash: genesis_block(network).header.bitcoin_hash(),
389                         fee_estimator: feeest.clone(),
390                         monitor: monitor.clone(),
391                         chain_monitor,
392                         tx_broadcaster,
393
394                         announce_channels_publicly,
395                         fee_proportional_millionths,
396                         latest_block_height: AtomicUsize::new(0), //TODO: Get an init value (generally need to replay recent chain on chain_monitor registration)
397                         secp_ctx,
398
399                         channel_state: Mutex::new(ChannelHolder{
400                                 by_id: HashMap::new(),
401                                 short_to_id: HashMap::new(),
402                                 next_forward: Instant::now(),
403                                 forward_htlcs: HashMap::new(),
404                                 claimable_htlcs: HashMap::new(),
405                                 pending_msg_events: Vec::new(),
406                         }),
407                         our_network_key: keys_manager.get_node_secret(),
408
409                         pending_events: Mutex::new(Vec::new()),
410
411                         keys_manager,
412
413                         logger,
414                 });
415                 let weak_res = Arc::downgrade(&res);
416                 res.chain_monitor.register_listener(weak_res);
417                 Ok(res)
418         }
419
420         /// Creates a new outbound channel to the given remote node and with the given value.
421         ///
422         /// user_id will be provided back as user_channel_id in FundingGenerationReady and
423         /// FundingBroadcastSafe events to allow tracking of which events correspond with which
424         /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
425         /// may wish to avoid using 0 for user_id here.
426         ///
427         /// If successful, will generate a SendOpenChannel message event, so you should probably poll
428         /// PeerManager::process_events afterwards.
429         ///
430         /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat being greater than channel_value_satoshis * 1k
431         pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
432                 let channel = Channel::new_outbound(&*self.fee_estimator, &self.keys_manager, their_network_key, channel_value_satoshis, push_msat, self.announce_channels_publicly, user_id, Arc::clone(&self.logger))?;
433                 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
434                 let mut channel_state = self.channel_state.lock().unwrap();
435                 match channel_state.by_id.entry(channel.channel_id()) {
436                         hash_map::Entry::Occupied(_) => {
437                                 if cfg!(feature = "fuzztarget") {
438                                         return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
439                                 } else {
440                                         panic!("RNG is bad???");
441                                 }
442                         },
443                         hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
444                 }
445                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
446                         node_id: their_network_key,
447                         msg: res,
448                 });
449                 Ok(())
450         }
451
452         /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
453         /// more information.
454         pub fn list_channels(&self) -> Vec<ChannelDetails> {
455                 let channel_state = self.channel_state.lock().unwrap();
456                 let mut res = Vec::with_capacity(channel_state.by_id.len());
457                 for (channel_id, channel) in channel_state.by_id.iter() {
458                         res.push(ChannelDetails {
459                                 channel_id: (*channel_id).clone(),
460                                 short_channel_id: channel.get_short_channel_id(),
461                                 remote_network_id: channel.get_their_node_id(),
462                                 channel_value_satoshis: channel.get_value_satoshis(),
463                                 user_id: channel.get_user_id(),
464                         });
465                 }
466                 res
467         }
468
469         /// Gets the list of usable channels, in random order. Useful as an argument to
470         /// Router::get_route to ensure non-announced channels are used.
471         pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
472                 let channel_state = self.channel_state.lock().unwrap();
473                 let mut res = Vec::with_capacity(channel_state.by_id.len());
474                 for (channel_id, channel) in channel_state.by_id.iter() {
475                         // Note we use is_live here instead of usable which leads to somewhat confused
476                         // internal/external nomenclature, but that's ok cause that's probably what the user
477                         // really wanted anyway.
478                         if channel.is_live() {
479                                 res.push(ChannelDetails {
480                                         channel_id: (*channel_id).clone(),
481                                         short_channel_id: channel.get_short_channel_id(),
482                                         remote_network_id: channel.get_their_node_id(),
483                                         channel_value_satoshis: channel.get_value_satoshis(),
484                                         user_id: channel.get_user_id(),
485                                 });
486                         }
487                 }
488                 res
489         }
490
491         /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
492         /// will be accepted on the given channel, and after additional timeout/the closing of all
493         /// pending HTLCs, the channel will be closed on chain.
494         ///
495         /// May generate a SendShutdown message event on success, which should be relayed.
496         pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
497                 let (mut failed_htlcs, chan_option) = {
498                         let mut channel_state_lock = self.channel_state.lock().unwrap();
499                         let channel_state = channel_state_lock.borrow_parts();
500                         match channel_state.by_id.entry(channel_id.clone()) {
501                                 hash_map::Entry::Occupied(mut chan_entry) => {
502                                         let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
503                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
504                                                 node_id: chan_entry.get().get_their_node_id(),
505                                                 msg: shutdown_msg
506                                         });
507                                         if chan_entry.get().is_shutdown() {
508                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
509                                                         channel_state.short_to_id.remove(&short_id);
510                                                 }
511                                                 (failed_htlcs, Some(chan_entry.remove_entry().1))
512                                         } else { (failed_htlcs, None) }
513                                 },
514                                 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
515                         }
516                 };
517                 for htlc_source in failed_htlcs.drain(..) {
518                         // unknown_next_peer...I dunno who that is anymore....
519                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
520                 }
521                 let chan_update = if let Some(chan) = chan_option {
522                         if let Ok(update) = self.get_channel_update(&chan) {
523                                 Some(update)
524                         } else { None }
525                 } else { None };
526
527                 if let Some(update) = chan_update {
528                         let mut channel_state = self.channel_state.lock().unwrap();
529                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
530                                 msg: update
531                         });
532                 }
533
534                 Ok(())
535         }
536
537         #[inline]
538         fn finish_force_close_channel(&self, shutdown_res: (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>)) {
539                 let (local_txn, mut failed_htlcs) = shutdown_res;
540                 for htlc_source in failed_htlcs.drain(..) {
541                         // unknown_next_peer...I dunno who that is anymore....
542                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
543                 }
544                 for tx in local_txn {
545                         self.tx_broadcaster.broadcast_transaction(&tx);
546                 }
547                 //TODO: We need to have a way where outbound HTLC claims can result in us claiming the
548                 //now-on-chain HTLC output for ourselves (and, thereafter, passing the HTLC backwards).
549                 //TODO: We need to handle monitoring of pending offered HTLCs which just hit the chain and
550                 //may be claimed, resulting in us claiming the inbound HTLCs (and back-failing after
551                 //timeouts are hit and our claims confirm).
552                 //TODO: In any case, we need to make sure we remove any pending htlc tracking (via
553                 //fail_backwards or claim_funds) eventually for all HTLCs that were in the channel
554         }
555
556         /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
557         /// the chain and rejecting new HTLCs on the given channel.
558         pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
559                 let mut chan = {
560                         let mut channel_state_lock = self.channel_state.lock().unwrap();
561                         let channel_state = channel_state_lock.borrow_parts();
562                         if let Some(chan) = channel_state.by_id.remove(channel_id) {
563                                 if let Some(short_id) = chan.get_short_channel_id() {
564                                         channel_state.short_to_id.remove(&short_id);
565                                 }
566                                 chan
567                         } else {
568                                 return;
569                         }
570                 };
571                 self.finish_force_close_channel(chan.force_shutdown());
572                 if let Ok(update) = self.get_channel_update(&chan) {
573                         let mut channel_state = self.channel_state.lock().unwrap();
574                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
575                                 msg: update
576                         });
577                 }
578         }
579
580         /// Force close all channels, immediately broadcasting the latest local commitment transaction
581         /// for each to the chain and rejecting new HTLCs on each.
582         pub fn force_close_all_channels(&self) {
583                 for chan in self.list_channels() {
584                         self.force_close_channel(&chan.channel_id);
585                 }
586         }
587
588         fn handle_monitor_update_fail(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, channel_id: &[u8; 32], err: ChannelMonitorUpdateErr, reason: RAACommitmentOrder) {
589                 match err {
590                         ChannelMonitorUpdateErr::PermanentFailure => {
591                                 let mut chan = {
592                                         let channel_state = channel_state_lock.borrow_parts();
593                                         let chan = channel_state.by_id.remove(channel_id).expect("monitor_update_failed must be called within the same lock as the channel get!");
594                                         if let Some(short_id) = chan.get_short_channel_id() {
595                                                 channel_state.short_to_id.remove(&short_id);
596                                         }
597                                         chan
598                                 };
599                                 mem::drop(channel_state_lock);
600                                 self.finish_force_close_channel(chan.force_shutdown());
601                                 if let Ok(update) = self.get_channel_update(&chan) {
602                                         let mut channel_state = self.channel_state.lock().unwrap();
603                                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
604                                                 msg: update
605                                         });
606                                 }
607                         },
608                         ChannelMonitorUpdateErr::TemporaryFailure => {
609                                 let channel = channel_state_lock.by_id.get_mut(channel_id).expect("monitor_update_failed must be called within the same lock as the channel get!");
610                                 channel.monitor_update_failed(reason);
611                         },
612                 }
613         }
614
615         #[inline]
616         fn gen_rho_mu_from_shared_secret(shared_secret: &SharedSecret) -> ([u8; 32], [u8; 32]) {
617                 ({
618                         let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
619                         hmac.input(&shared_secret[..]);
620                         let mut res = [0; 32];
621                         hmac.raw_result(&mut res);
622                         res
623                 },
624                 {
625                         let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
626                         hmac.input(&shared_secret[..]);
627                         let mut res = [0; 32];
628                         hmac.raw_result(&mut res);
629                         res
630                 })
631         }
632
633         #[inline]
634         fn gen_um_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
635                 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
636                 hmac.input(&shared_secret[..]);
637                 let mut res = [0; 32];
638                 hmac.raw_result(&mut res);
639                 res
640         }
641
642         #[inline]
643         fn gen_ammag_from_shared_secret(shared_secret: &SharedSecret) -> [u8; 32] {
644                 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
645                 hmac.input(&shared_secret[..]);
646                 let mut res = [0; 32];
647                 hmac.raw_result(&mut res);
648                 res
649         }
650
651         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
652         #[inline]
653         fn construct_onion_keys_callback<T: secp256k1::Signing, FType: FnMut(SharedSecret, [u8; 32], PublicKey, &RouteHop)> (secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey, mut callback: FType) -> Result<(), secp256k1::Error> {
654                 let mut blinded_priv = session_priv.clone();
655                 let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
656
657                 for hop in route.hops.iter() {
658                         let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
659
660                         let mut sha = Sha256::new();
661                         sha.input(&blinded_pub.serialize()[..]);
662                         sha.input(&shared_secret[..]);
663                         let mut blinding_factor = [0u8; 32];
664                         sha.result(&mut blinding_factor);
665
666                         let ephemeral_pubkey = blinded_pub;
667
668                         blinded_priv.mul_assign(secp_ctx, &SecretKey::from_slice(secp_ctx, &blinding_factor)?)?;
669                         blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
670
671                         callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
672                 }
673
674                 Ok(())
675         }
676
677         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
678         fn construct_onion_keys<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, secp256k1::Error> {
679                 let mut res = Vec::with_capacity(route.hops.len());
680
681                 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
682                         let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
683
684                         res.push(OnionKeys {
685                                 #[cfg(test)]
686                                 shared_secret,
687                                 #[cfg(test)]
688                                 blinding_factor: _blinding_factor,
689                                 ephemeral_pubkey,
690                                 rho,
691                                 mu,
692                         });
693                 })?;
694
695                 Ok(res)
696         }
697
698         /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
699         fn build_onion_payloads(route: &Route, starting_htlc_offset: u32) -> Result<(Vec<msgs::OnionHopData>, u64, u32), APIError> {
700                 let mut cur_value_msat = 0u64;
701                 let mut cur_cltv = starting_htlc_offset;
702                 let mut last_short_channel_id = 0;
703                 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
704                 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
705                 unsafe { res.set_len(route.hops.len()); }
706
707                 for (idx, hop) in route.hops.iter().enumerate().rev() {
708                         // First hop gets special values so that it can check, on receipt, that everything is
709                         // exactly as it should be (and the next hop isn't trying to probe to find out if we're
710                         // the intended recipient).
711                         let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
712                         let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
713                         res[idx] = msgs::OnionHopData {
714                                 realm: 0,
715                                 data: msgs::OnionRealm0HopData {
716                                         short_channel_id: last_short_channel_id,
717                                         amt_to_forward: value_msat,
718                                         outgoing_cltv_value: cltv,
719                                 },
720                                 hmac: [0; 32],
721                         };
722                         cur_value_msat += hop.fee_msat;
723                         if cur_value_msat >= 21000000 * 100000000 * 1000 {
724                                 return Err(APIError::RouteError{err: "Channel fees overflowed?!"});
725                         }
726                         cur_cltv += hop.cltv_expiry_delta as u32;
727                         if cur_cltv >= 500000000 {
728                                 return Err(APIError::RouteError{err: "Channel CLTV overflowed?!"});
729                         }
730                         last_short_channel_id = hop.short_channel_id;
731                 }
732                 Ok((res, cur_value_msat, cur_cltv))
733         }
734
735         #[inline]
736         fn shift_arr_right(arr: &mut [u8; 20*65]) {
737                 unsafe {
738                         ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
739                 }
740                 for i in 0..65 {
741                         arr[i] = 0;
742                 }
743         }
744
745         #[inline]
746         fn xor_bufs(dst: &mut[u8], src: &[u8]) {
747                 assert_eq!(dst.len(), src.len());
748
749                 for i in 0..dst.len() {
750                         dst[i] ^= src[i];
751                 }
752         }
753
754         const ZERO:[u8; 21*65] = [0; 21*65];
755         fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: &[u8; 32]) -> msgs::OnionPacket {
756                 let mut buf = Vec::with_capacity(21*65);
757                 buf.resize(21*65, 0);
758
759                 let filler = {
760                         let iters = payloads.len() - 1;
761                         let end_len = iters * 65;
762                         let mut res = Vec::with_capacity(end_len);
763                         res.resize(end_len, 0);
764
765                         for (i, keys) in onion_keys.iter().enumerate() {
766                                 if i == payloads.len() - 1 { continue; }
767                                 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
768                                 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
769                                 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
770                         }
771                         res
772                 };
773
774                 let mut packet_data = [0; 20*65];
775                 let mut hmac_res = [0; 32];
776
777                 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
778                         ChannelManager::shift_arr_right(&mut packet_data);
779                         payload.hmac = hmac_res;
780                         packet_data[0..65].copy_from_slice(&payload.encode()[..]);
781
782                         let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
783                         chacha.process(&packet_data, &mut buf[0..20*65]);
784                         packet_data[..].copy_from_slice(&buf[0..20*65]);
785
786                         if i == 0 {
787                                 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
788                         }
789
790                         let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
791                         hmac.input(&packet_data);
792                         hmac.input(&associated_data[..]);
793                         hmac.raw_result(&mut hmac_res);
794                 }
795
796                 msgs::OnionPacket{
797                         version: 0,
798                         public_key: Ok(onion_keys.first().unwrap().ephemeral_pubkey),
799                         hop_data: packet_data,
800                         hmac: hmac_res,
801                 }
802         }
803
804         /// Encrypts a failure packet. raw_packet can either be a
805         /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
806         fn encrypt_failure_packet(shared_secret: &SharedSecret, raw_packet: &[u8]) -> msgs::OnionErrorPacket {
807                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
808
809                 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
810                 packet_crypted.resize(raw_packet.len(), 0);
811                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
812                 chacha.process(&raw_packet, &mut packet_crypted[..]);
813                 msgs::OnionErrorPacket {
814                         data: packet_crypted,
815                 }
816         }
817
818         fn build_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
819                 assert!(failure_data.len() <= 256 - 2);
820
821                 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
822
823                 let failuremsg = {
824                         let mut res = Vec::with_capacity(2 + failure_data.len());
825                         res.push(((failure_type >> 8) & 0xff) as u8);
826                         res.push(((failure_type >> 0) & 0xff) as u8);
827                         res.extend_from_slice(&failure_data[..]);
828                         res
829                 };
830                 let pad = {
831                         let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
832                         res.resize(256 - 2 - failure_data.len(), 0);
833                         res
834                 };
835                 let mut packet = msgs::DecodedOnionErrorPacket {
836                         hmac: [0; 32],
837                         failuremsg: failuremsg,
838                         pad: pad,
839                 };
840
841                 let mut hmac = Hmac::new(Sha256::new(), &um);
842                 hmac.input(&packet.encode()[32..]);
843                 hmac.raw_result(&mut packet.hmac);
844
845                 packet
846         }
847
848         #[inline]
849         fn build_first_hop_failure_packet(shared_secret: &SharedSecret, failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
850                 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
851                 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
852         }
853
854         fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder>) {
855                 macro_rules! get_onion_hash {
856                         () => {
857                                 {
858                                         let mut sha = Sha256::new();
859                                         sha.input(&msg.onion_routing_packet.hop_data);
860                                         let mut onion_hash = [0; 32];
861                                         sha.result(&mut onion_hash);
862                                         onion_hash
863                                 }
864                         }
865                 }
866
867                 if let Err(_) = msg.onion_routing_packet.public_key {
868                         log_info!(self, "Failed to accept/forward incoming HTLC with invalid ephemeral pubkey");
869                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
870                                 channel_id: msg.channel_id,
871                                 htlc_id: msg.htlc_id,
872                                 sha256_of_onion: get_onion_hash!(),
873                                 failure_code: 0x8000 | 0x4000 | 6,
874                         })), self.channel_state.lock().unwrap());
875                 }
876
877                 let shared_secret = SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key);
878                 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
879
880                 let mut channel_state = None;
881                 macro_rules! return_err {
882                         ($msg: expr, $err_code: expr, $data: expr) => {
883                                 {
884                                         log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
885                                         if channel_state.is_none() {
886                                                 channel_state = Some(self.channel_state.lock().unwrap());
887                                         }
888                                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
889                                                 channel_id: msg.channel_id,
890                                                 htlc_id: msg.htlc_id,
891                                                 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
892                                         })), channel_state.unwrap());
893                                 }
894                         }
895                 }
896
897                 if msg.onion_routing_packet.version != 0 {
898                         //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
899                         //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
900                         //the hash doesn't really serve any purpuse - in the case of hashing all data, the
901                         //receiving node would have to brute force to figure out which version was put in the
902                         //packet by the node that send us the message, in the case of hashing the hop_data, the
903                         //node knows the HMAC matched, so they already know what is there...
904                         return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
905                 }
906
907                 let mut hmac = Hmac::new(Sha256::new(), &mu);
908                 hmac.input(&msg.onion_routing_packet.hop_data);
909                 hmac.input(&msg.payment_hash);
910                 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
911                         return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
912                 }
913
914                 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
915                 let next_hop_data = {
916                         let mut decoded = [0; 65];
917                         chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
918                         match msgs::OnionHopData::read(&mut Cursor::new(&decoded[..])) {
919                                 Err(err) => {
920                                         let error_code = match err {
921                                                 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
922                                                 _ => 0x2000 | 2, // Should never happen
923                                         };
924                                         return_err!("Unable to decode our hop data", error_code, &[0;0]);
925                                 },
926                                 Ok(msg) => msg
927                         }
928                 };
929
930                 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
931                                 // OUR PAYMENT!
932                                 // final_expiry_too_soon
933                                 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS) as u64 {
934                                         return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
935                                 }
936                                 // final_incorrect_htlc_amount
937                                 if next_hop_data.data.amt_to_forward > msg.amount_msat {
938                                         return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
939                                 }
940                                 // final_incorrect_cltv_expiry
941                                 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
942                                         return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
943                                 }
944
945                                 // Note that we could obviously respond immediately with an update_fulfill_htlc
946                                 // message, however that would leak that we are the recipient of this payment, so
947                                 // instead we stay symmetric with the forwarding case, only responding (after a
948                                 // delay) once they've send us a commitment_signed!
949
950                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
951                                         onion_packet: None,
952                                         payment_hash: msg.payment_hash.clone(),
953                                         short_channel_id: 0,
954                                         incoming_shared_secret: shared_secret.clone(),
955                                         amt_to_forward: next_hop_data.data.amt_to_forward,
956                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
957                                 })
958                         } else {
959                                 let mut new_packet_data = [0; 20*65];
960                                 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
961                                 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
962
963                                 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
964
965                                 let blinding_factor = {
966                                         let mut sha = Sha256::new();
967                                         sha.input(&new_pubkey.serialize()[..]);
968                                         sha.input(&shared_secret[..]);
969                                         let mut res = [0u8; 32];
970                                         sha.result(&mut res);
971                                         match SecretKey::from_slice(&self.secp_ctx, &res) {
972                                                 Err(_) => {
973                                                         return_err!("Blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
974                                                 },
975                                                 Ok(key) => key
976                                         }
977                                 };
978
979                                 if let Err(_) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
980                                         return_err!("New blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
981                                 }
982
983                                 let outgoing_packet = msgs::OnionPacket {
984                                         version: 0,
985                                         public_key: Ok(new_pubkey),
986                                         hop_data: new_packet_data,
987                                         hmac: next_hop_data.hmac.clone(),
988                                 };
989
990                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
991                                         onion_packet: Some(outgoing_packet),
992                                         payment_hash: msg.payment_hash.clone(),
993                                         short_channel_id: next_hop_data.data.short_channel_id,
994                                         incoming_shared_secret: shared_secret.clone(),
995                                         amt_to_forward: next_hop_data.data.amt_to_forward,
996                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
997                                 })
998                         };
999
1000                 channel_state = Some(self.channel_state.lock().unwrap());
1001                 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1002                         if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1003                                 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1004                                 let forwarding_id = match id_option {
1005                                         None => { // unknown_next_peer
1006                                                 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1007                                         },
1008                                         Some(id) => id.clone(),
1009                                 };
1010                                 if let Some((err, code, chan_update)) = loop {
1011                                         let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1012
1013                                         // Note that we could technically not return an error yet here and just hope
1014                                         // that the connection is reestablished or monitor updated by the time we get
1015                                         // around to doing the actual forward, but better to fail early if we can and
1016                                         // hopefully an attacker trying to path-trace payments cannot make this occur
1017                                         // on a small/per-node/per-channel scale.
1018                                         if !chan.is_live() { // channel_disabled
1019                                                 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1020                                         }
1021                                         if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
1022                                                 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1023                                         }
1024                                         let fee = amt_to_forward.checked_mul(self.fee_proportional_millionths as u64).and_then(|prop_fee| { (prop_fee / 1000000).checked_add(chan.get_our_fee_base_msat(&*self.fee_estimator) as u64) });
1025                                         if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1026                                                 break Some(("Prior hop has deviated from specified fees parameters or origin node has obsolete ones", 0x1000 | 12, Some(self.get_channel_update(chan).unwrap())));
1027                                         }
1028                                         if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1029                                                 break Some(("Forwarding node has tampered with the intended HTLC values or origin node has an obsolete cltv_expiry_delta", 0x1000 | 13, Some(self.get_channel_update(chan).unwrap())));
1030                                         }
1031                                         let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1032                                         // We want to have at least HTLC_FAIL_TIMEOUT_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1033                                         if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS as u32 { // expiry_too_soon
1034                                                 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1035                                         }
1036                                         if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1037                                                 break Some(("CLTV expiry is too far in the future", 21, None));
1038                                         }
1039                                         break None;
1040                                 }
1041                                 {
1042                                         let mut res = Vec::with_capacity(8 + 128);
1043                                         if code == 0x1000 | 11 || code == 0x1000 | 12 {
1044                                                 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1045                                         }
1046                                         else if code == 0x1000 | 13 {
1047                                                 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1048                                         }
1049                                         if let Some(chan_update) = chan_update {
1050                                                 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1051                                         }
1052                                         return_err!(err, code, &res[..]);
1053                                 }
1054                         }
1055                 }
1056
1057                 (pending_forward_info, channel_state.unwrap())
1058         }
1059
1060         /// only fails if the channel does not yet have an assigned short_id
1061         /// May be called with channel_state already locked!
1062         fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
1063                 let short_channel_id = match chan.get_short_channel_id() {
1064                         None => return Err(HandleError{err: "Channel not yet established", action: None}),
1065                         Some(id) => id,
1066                 };
1067
1068                 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1069
1070                 let unsigned = msgs::UnsignedChannelUpdate {
1071                         chain_hash: self.genesis_hash,
1072                         short_channel_id: short_channel_id,
1073                         timestamp: chan.get_channel_update_count(),
1074                         flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1075                         cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1076                         htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1077                         fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1078                         fee_proportional_millionths: self.fee_proportional_millionths,
1079                         excess_data: Vec::new(),
1080                 };
1081
1082                 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
1083                 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key);
1084
1085                 Ok(msgs::ChannelUpdate {
1086                         signature: sig,
1087                         contents: unsigned
1088                 })
1089         }
1090
1091         /// Sends a payment along a given route.
1092         ///
1093         /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1094         /// fields for more info.
1095         ///
1096         /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1097         /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1098         /// next hop knows the preimage to payment_hash they can claim an additional amount as
1099         /// specified in the last hop in the route! Thus, you should probably do your own
1100         /// payment_preimage tracking (which you should already be doing as they represent "proof of
1101         /// payment") and prevent double-sends yourself.
1102         ///
1103         /// May generate a SendHTLCs message event on success, which should be relayed.
1104         ///
1105         /// Raises APIError::RoutError when invalid route or forward parameter
1106         /// (cltv_delta, fee, node public key) is specified
1107         pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), APIError> {
1108                 if route.hops.len() < 1 || route.hops.len() > 20 {
1109                         return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1110                 }
1111                 let our_node_id = self.get_our_node_id();
1112                 for (idx, hop) in route.hops.iter().enumerate() {
1113                         if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1114                                 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1115                         }
1116                 }
1117
1118                 let session_priv = SecretKey::from_slice(&self.secp_ctx, &{
1119                         let mut session_key = [0; 32];
1120                         rng::fill_bytes(&mut session_key);
1121                         session_key
1122                 }).expect("RNG is bad!");
1123
1124                 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1125
1126                 let onion_keys = secp_call!(ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1127                                 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1128                 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height)?;
1129                 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
1130
1131                 let mut channel_state = self.channel_state.lock().unwrap();
1132
1133                 let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1134                         None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1135                         Some(id) => id.clone(),
1136                 };
1137
1138                 let res = {
1139                         let chan = channel_state.by_id.get_mut(&id).unwrap();
1140                         if chan.get_their_node_id() != route.hops.first().unwrap().pubkey {
1141                                 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1142                         }
1143                         if chan.is_awaiting_monitor_update() {
1144                                 return Err(APIError::MonitorUpdateFailed);
1145                         }
1146                         if !chan.is_live() {
1147                                 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected!"});
1148                         }
1149                         chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1150                                 route: route.clone(),
1151                                 session_priv: session_priv.clone(),
1152                                 first_hop_htlc_msat: htlc_msat,
1153                         }, onion_packet).map_err(|he| APIError::ChannelUnavailable{err: he.err})?
1154                 };
1155                 match res {
1156                         Some((update_add, commitment_signed, chan_monitor)) => {
1157                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1158                                         self.handle_monitor_update_fail(channel_state, &id, e, RAACommitmentOrder::CommitmentFirst);
1159                                         return Err(APIError::MonitorUpdateFailed);
1160                                 }
1161
1162                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1163                                         node_id: route.hops.first().unwrap().pubkey,
1164                                         updates: msgs::CommitmentUpdate {
1165                                                 update_add_htlcs: vec![update_add],
1166                                                 update_fulfill_htlcs: Vec::new(),
1167                                                 update_fail_htlcs: Vec::new(),
1168                                                 update_fail_malformed_htlcs: Vec::new(),
1169                                                 update_fee: None,
1170                                                 commitment_signed,
1171                                         },
1172                                 });
1173                         },
1174                         None => {},
1175                 }
1176
1177                 Ok(())
1178         }
1179
1180         /// Call this upon creation of a funding transaction for the given channel.
1181         ///
1182         /// Panics if a funding transaction has already been provided for this channel.
1183         ///
1184         /// May panic if the funding_txo is duplicative with some other channel (note that this should
1185         /// be trivially prevented by using unique funding transaction keys per-channel).
1186         pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1187                 let (chan, msg, chan_monitor) = {
1188                         let mut channel_state = self.channel_state.lock().unwrap();
1189                         match channel_state.by_id.remove(temporary_channel_id) {
1190                                 Some(mut chan) => {
1191                                         match chan.get_outbound_funding_created(funding_txo) {
1192                                                 Ok(funding_msg) => {
1193                                                         (chan, funding_msg.0, funding_msg.1)
1194                                                 },
1195                                                 Err(e) => {
1196                                                         log_error!(self, "Got bad signatures: {}!", e.err);
1197                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1198                                                                 node_id: chan.get_their_node_id(),
1199                                                                 action: e.action,
1200                                                         });
1201                                                         return;
1202                                                 },
1203                                         }
1204                                 },
1205                                 None => return
1206                         }
1207                 };
1208                 // Because we have exclusive ownership of the channel here we can release the channel_state
1209                 // lock before add_update_monitor
1210                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1211                         unimplemented!();
1212                 }
1213
1214                 let mut channel_state = self.channel_state.lock().unwrap();
1215                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1216                         node_id: chan.get_their_node_id(),
1217                         msg: msg,
1218                 });
1219                 match channel_state.by_id.entry(chan.channel_id()) {
1220                         hash_map::Entry::Occupied(_) => {
1221                                 panic!("Generated duplicate funding txid?");
1222                         },
1223                         hash_map::Entry::Vacant(e) => {
1224                                 e.insert(chan);
1225                         }
1226                 }
1227         }
1228
1229         fn get_announcement_sigs(&self, chan: &Channel) -> Option<msgs::AnnouncementSignatures> {
1230                 if !chan.should_announce() { return None }
1231
1232                 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1233                         Ok(res) => res,
1234                         Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1235                 };
1236                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1237                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1238
1239                 Some(msgs::AnnouncementSignatures {
1240                         channel_id: chan.channel_id(),
1241                         short_channel_id: chan.get_short_channel_id().unwrap(),
1242                         node_signature: our_node_sig,
1243                         bitcoin_signature: our_bitcoin_sig,
1244                 })
1245         }
1246
1247         /// Processes HTLCs which are pending waiting on random forward delay.
1248         ///
1249         /// Should only really ever be called in response to an PendingHTLCsForwardable event.
1250         /// Will likely generate further events.
1251         pub fn process_pending_htlc_forwards(&self) {
1252                 let mut new_events = Vec::new();
1253                 let mut failed_forwards = Vec::new();
1254                 {
1255                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1256                         let channel_state = channel_state_lock.borrow_parts();
1257
1258                         if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
1259                                 return;
1260                         }
1261
1262                         for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1263                                 if short_chan_id != 0 {
1264                                         let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1265                                                 Some(chan_id) => chan_id.clone(),
1266                                                 None => {
1267                                                         failed_forwards.reserve(pending_forwards.len());
1268                                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1269                                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1270                                                                         short_channel_id: prev_short_channel_id,
1271                                                                         htlc_id: prev_htlc_id,
1272                                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1273                                                                 });
1274                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1275                                                         }
1276                                                         continue;
1277                                                 }
1278                                         };
1279                                         let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
1280
1281                                         let mut add_htlc_msgs = Vec::new();
1282                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1283                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1284                                                         short_channel_id: prev_short_channel_id,
1285                                                         htlc_id: prev_htlc_id,
1286                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1287                                                 });
1288                                                 match forward_chan.send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, htlc_source.clone(), forward_info.onion_packet.unwrap()) {
1289                                                         Err(_e) => {
1290                                                                 let chan_update = self.get_channel_update(forward_chan).unwrap();
1291                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1292                                                                 continue;
1293                                                         },
1294                                                         Ok(update_add) => {
1295                                                                 match update_add {
1296                                                                         Some(msg) => { add_htlc_msgs.push(msg); },
1297                                                                         None => {
1298                                                                                 // Nothing to do here...we're waiting on a remote
1299                                                                                 // revoke_and_ack before we can add anymore HTLCs. The Channel
1300                                                                                 // will automatically handle building the update_add_htlc and
1301                                                                                 // commitment_signed messages when we can.
1302                                                                                 // TODO: Do some kind of timer to set the channel as !is_live()
1303                                                                                 // as we don't really want others relying on us relaying through
1304                                                                                 // this channel currently :/.
1305                                                                         }
1306                                                                 }
1307                                                         }
1308                                                 }
1309                                         }
1310
1311                                         if !add_htlc_msgs.is_empty() {
1312                                                 let (commitment_msg, monitor) = match forward_chan.send_commitment() {
1313                                                         Ok(res) => res,
1314                                                         Err(e) => {
1315                                                                 if let &Some(msgs::ErrorAction::DisconnectPeer{msg: Some(ref _err_msg)}) = &e.action {
1316                                                                 } else if let &Some(msgs::ErrorAction::SendErrorMessage{msg: ref _err_msg}) = &e.action {
1317                                                                 } else {
1318                                                                         panic!("Stated return value requirements in send_commitment() were not met");
1319                                                                 }
1320                                                                 //TODO: Handle...this is bad!
1321                                                                 continue;
1322                                                         },
1323                                                 };
1324                                                 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1325                                                         unimplemented!();// but def dont push the event...
1326                                                 }
1327                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1328                                                         node_id: forward_chan.get_their_node_id(),
1329                                                         updates: msgs::CommitmentUpdate {
1330                                                                 update_add_htlcs: add_htlc_msgs,
1331                                                                 update_fulfill_htlcs: Vec::new(),
1332                                                                 update_fail_htlcs: Vec::new(),
1333                                                                 update_fail_malformed_htlcs: Vec::new(),
1334                                                                 update_fee: None,
1335                                                                 commitment_signed: commitment_msg,
1336                                                         },
1337                                                 });
1338                                         }
1339                                 } else {
1340                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1341                                                 let prev_hop_data = HTLCPreviousHopData {
1342                                                         short_channel_id: prev_short_channel_id,
1343                                                         htlc_id: prev_htlc_id,
1344                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1345                                                 };
1346                                                 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1347                                                         hash_map::Entry::Occupied(mut entry) => entry.get_mut().push(prev_hop_data),
1348                                                         hash_map::Entry::Vacant(entry) => { entry.insert(vec![prev_hop_data]); },
1349                                                 };
1350                                                 new_events.push(events::Event::PaymentReceived {
1351                                                         payment_hash: forward_info.payment_hash,
1352                                                         amt: forward_info.amt_to_forward,
1353                                                 });
1354                                         }
1355                                 }
1356                         }
1357                 }
1358
1359                 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1360                         match update {
1361                                 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1362                                 Some(chan_update) => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: chan_update.encode_with_len() }),
1363                         };
1364                 }
1365
1366                 if new_events.is_empty() { return }
1367                 let mut events = self.pending_events.lock().unwrap();
1368                 events.append(&mut new_events);
1369         }
1370
1371         /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect after a PaymentReceived event.
1372         pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32], reason: PaymentFailReason) -> bool {
1373                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1374                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1375                 if let Some(mut sources) = removed_source {
1376                         for htlc_with_hash in sources.drain(..) {
1377                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1378                                 self.fail_htlc_backwards_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_hash, HTLCFailReason::Reason { failure_code: if reason == PaymentFailReason::PreimageUnknown {0x4000 | 15} else {0x4000 | 16}, data: Vec::new() });
1379                         }
1380                         true
1381                 } else { false }
1382         }
1383
1384         /// Fails an HTLC backwards to the sender of it to us.
1385         /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1386         /// There are several callsites that do stupid things like loop over a list of payment_hashes
1387         /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1388         /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1389         /// still-available channels.
1390         fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_hash: &[u8; 32], onion_error: HTLCFailReason) {
1391                 match source {
1392                         HTLCSource::OutboundRoute { .. } => {
1393                                 mem::drop(channel_state_lock);
1394                                 if let &HTLCFailReason::ErrorPacket { ref err } = &onion_error {
1395                                         let (channel_update, payment_retryable) = self.process_onion_failure(&source, err.data.clone());
1396                                         if let Some(update) = channel_update {
1397                                                 self.channel_state.lock().unwrap().pending_msg_events.push(
1398                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate {
1399                                                                 update,
1400                                                         }
1401                                                 );
1402                                         }
1403                                         self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
1404                                                 payment_hash: payment_hash.clone(),
1405                                                 rejected_by_dest: !payment_retryable,
1406                                         });
1407                                 } else {
1408                                         panic!("should have onion error packet here");
1409                                 }
1410                         },
1411                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1412                                 let err_packet = match onion_error {
1413                                         HTLCFailReason::Reason { failure_code, data } => {
1414                                                 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1415                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1416                                         },
1417                                         HTLCFailReason::ErrorPacket { err } => {
1418                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1419                                         }
1420                                 };
1421
1422                                 let channel_state = channel_state_lock.borrow_parts();
1423
1424                                 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1425                                         Some(chan_id) => chan_id.clone(),
1426                                         None => return
1427                                 };
1428
1429                                 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1430                                 match chan.get_update_fail_htlc_and_commit(htlc_id, err_packet) {
1431                                         Ok(Some((msg, commitment_msg, chan_monitor))) => {
1432                                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1433                                                         unimplemented!();
1434                                                 }
1435                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1436                                                         node_id: chan.get_their_node_id(),
1437                                                         updates: msgs::CommitmentUpdate {
1438                                                                 update_add_htlcs: Vec::new(),
1439                                                                 update_fulfill_htlcs: Vec::new(),
1440                                                                 update_fail_htlcs: vec![msg],
1441                                                                 update_fail_malformed_htlcs: Vec::new(),
1442                                                                 update_fee: None,
1443                                                                 commitment_signed: commitment_msg,
1444                                                         },
1445                                                 });
1446                                         },
1447                                         Ok(None) => {},
1448                                         Err(_e) => {
1449                                                 //TODO: Do something with e?
1450                                                 return;
1451                                         },
1452                                 }
1453                         },
1454                 }
1455         }
1456
1457         /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1458         /// generating message events for the net layer to claim the payment, if possible. Thus, you
1459         /// should probably kick the net layer to go send messages if this returns true!
1460         ///
1461         /// May panic if called except in response to a PaymentReceived event.
1462         pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
1463                 let mut sha = Sha256::new();
1464                 sha.input(&payment_preimage);
1465                 let mut payment_hash = [0; 32];
1466                 sha.result(&mut payment_hash);
1467
1468                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1469                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1470                 if let Some(mut sources) = removed_source {
1471                         for htlc_with_hash in sources.drain(..) {
1472                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1473                                 self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1474                         }
1475                         true
1476                 } else { false }
1477         }
1478         fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_preimage: [u8; 32]) {
1479                 match source {
1480                         HTLCSource::OutboundRoute { .. } => {
1481                                 mem::drop(channel_state_lock);
1482                                 let mut pending_events = self.pending_events.lock().unwrap();
1483                                 pending_events.push(events::Event::PaymentSent {
1484                                         payment_preimage
1485                                 });
1486                         },
1487                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1488                                 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1489                                 let channel_state = channel_state_lock.borrow_parts();
1490
1491                                 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1492                                         Some(chan_id) => chan_id.clone(),
1493                                         None => {
1494                                                 // TODO: There is probably a channel manager somewhere that needs to
1495                                                 // learn the preimage as the channel already hit the chain and that's
1496                                                 // why its missing.
1497                                                 return
1498                                         }
1499                                 };
1500
1501                                 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1502                                 match chan.get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1503                                         Ok((msgs, monitor_option)) => {
1504                                                 if let Some(chan_monitor) = monitor_option {
1505                                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1506                                                                 unimplemented!();// but def dont push the event...
1507                                                         }
1508                                                 }
1509                                                 if let Some((msg, commitment_signed)) = msgs {
1510                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1511                                                                 node_id: chan.get_their_node_id(),
1512                                                                 updates: msgs::CommitmentUpdate {
1513                                                                         update_add_htlcs: Vec::new(),
1514                                                                         update_fulfill_htlcs: vec![msg],
1515                                                                         update_fail_htlcs: Vec::new(),
1516                                                                         update_fail_malformed_htlcs: Vec::new(),
1517                                                                         update_fee: None,
1518                                                                         commitment_signed,
1519                                                                 }
1520                                                         });
1521                                                 }
1522                                         },
1523                                         Err(_e) => {
1524                                                 // TODO: There is probably a channel manager somewhere that needs to
1525                                                 // learn the preimage as the channel may be about to hit the chain.
1526                                                 //TODO: Do something with e?
1527                                                 return
1528                                         },
1529                                 }
1530                         },
1531                 }
1532         }
1533
1534         /// Gets the node_id held by this ChannelManager
1535         pub fn get_our_node_id(&self) -> PublicKey {
1536                 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1537         }
1538
1539         /// Used to restore channels to normal operation after a
1540         /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1541         /// operation.
1542         pub fn test_restore_channel_monitor(&self) {
1543                 let mut close_results = Vec::new();
1544                 let mut htlc_forwards = Vec::new();
1545                 let mut htlc_failures = Vec::new();
1546
1547                 {
1548                         let mut channel_lock = self.channel_state.lock().unwrap();
1549                         let channel_state = channel_lock.borrow_parts();
1550                         let short_to_id = channel_state.short_to_id;
1551                         let pending_msg_events = channel_state.pending_msg_events;
1552                         channel_state.by_id.retain(|_, channel| {
1553                                 if channel.is_awaiting_monitor_update() {
1554                                         let chan_monitor = channel.channel_monitor();
1555                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1556                                                 match e {
1557                                                         ChannelMonitorUpdateErr::PermanentFailure => {
1558                                                                 if let Some(short_id) = channel.get_short_channel_id() {
1559                                                                         short_to_id.remove(&short_id);
1560                                                                 }
1561                                                                 close_results.push(channel.force_shutdown());
1562                                                                 if let Ok(update) = self.get_channel_update(&channel) {
1563                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1564                                                                                 msg: update
1565                                                                         });
1566                                                                 }
1567                                                                 false
1568                                                         },
1569                                                         ChannelMonitorUpdateErr::TemporaryFailure => true,
1570                                                 }
1571                                         } else {
1572                                                 let (raa, commitment_update, order, pending_forwards, mut pending_failures) = channel.monitor_updating_restored();
1573                                                 if !pending_forwards.is_empty() {
1574                                                         htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1575                                                 }
1576                                                 htlc_failures.append(&mut pending_failures);
1577
1578                                                 macro_rules! handle_cs { () => {
1579                                                         if let Some(update) = commitment_update {
1580                                                                 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1581                                                                         node_id: channel.get_their_node_id(),
1582                                                                         updates: update,
1583                                                                 });
1584                                                         }
1585                                                 } }
1586                                                 macro_rules! handle_raa { () => {
1587                                                         if let Some(revoke_and_ack) = raa {
1588                                                                 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1589                                                                         node_id: channel.get_their_node_id(),
1590                                                                         msg: revoke_and_ack,
1591                                                                 });
1592                                                         }
1593                                                 } }
1594                                                 match order {
1595                                                         RAACommitmentOrder::CommitmentFirst => {
1596                                                                 handle_cs!();
1597                                                                 handle_raa!();
1598                                                         },
1599                                                         RAACommitmentOrder::RevokeAndACKFirst => {
1600                                                                 handle_raa!();
1601                                                                 handle_cs!();
1602                                                         },
1603                                                 }
1604                                                 true
1605                                         }
1606                                 } else { true }
1607                         });
1608                 }
1609
1610                 for failure in htlc_failures.drain(..) {
1611                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1612                 }
1613                 self.forward_htlcs(&mut htlc_forwards[..]);
1614
1615                 for res in close_results.drain(..) {
1616                         self.finish_force_close_channel(res);
1617                 }
1618         }
1619
1620         fn internal_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1621                 if msg.chain_hash != self.genesis_hash {
1622                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1623                 }
1624
1625                 let channel = Channel::new_from_req(&*self.fee_estimator, &self.keys_manager, their_node_id.clone(), msg, 0, false, self.announce_channels_publicly, Arc::clone(&self.logger))
1626                         .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1627                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1628                 let channel_state = channel_state_lock.borrow_parts();
1629                 match channel_state.by_id.entry(channel.channel_id()) {
1630                         hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1631                         hash_map::Entry::Vacant(entry) => {
1632                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1633                                         node_id: their_node_id.clone(),
1634                                         msg: channel.get_accept_channel(),
1635                                 });
1636                                 entry.insert(channel);
1637                         }
1638                 }
1639                 Ok(())
1640         }
1641
1642         fn internal_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1643                 let (value, output_script, user_id) = {
1644                         let mut channel_state = self.channel_state.lock().unwrap();
1645                         match channel_state.by_id.get_mut(&msg.temporary_channel_id) {
1646                                 Some(chan) => {
1647                                         if chan.get_their_node_id() != *their_node_id {
1648                                                 //TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
1649                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1650                                         }
1651                                         chan.accept_channel(&msg)
1652                                                 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.temporary_channel_id))?;
1653                                         (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id())
1654                                 },
1655                                 //TODO: same as above
1656                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1657                         }
1658                 };
1659                 let mut pending_events = self.pending_events.lock().unwrap();
1660                 pending_events.push(events::Event::FundingGenerationReady {
1661                         temporary_channel_id: msg.temporary_channel_id,
1662                         channel_value_satoshis: value,
1663                         output_script: output_script,
1664                         user_channel_id: user_id,
1665                 });
1666                 Ok(())
1667         }
1668
1669         fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1670                 let (chan, funding_msg, monitor_update) = {
1671                         let mut channel_state = self.channel_state.lock().unwrap();
1672                         match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1673                                 hash_map::Entry::Occupied(mut chan) => {
1674                                         if chan.get().get_their_node_id() != *their_node_id {
1675                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1676                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1677                                         }
1678                                         match chan.get_mut().funding_created(msg) {
1679                                                 Ok((funding_msg, monitor_update)) => {
1680                                                         (chan.remove(), funding_msg, monitor_update)
1681                                                 },
1682                                                 Err(e) => {
1683                                                         return Err(e).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))
1684                                                 }
1685                                         }
1686                                 },
1687                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1688                         }
1689                 };
1690                 // Because we have exclusive ownership of the channel here we can release the channel_state
1691                 // lock before add_update_monitor
1692                 if let Err(_e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1693                         unimplemented!();
1694                 }
1695                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1696                 let channel_state = channel_state_lock.borrow_parts();
1697                 match channel_state.by_id.entry(funding_msg.channel_id) {
1698                         hash_map::Entry::Occupied(_) => {
1699                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1700                         },
1701                         hash_map::Entry::Vacant(e) => {
1702                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
1703                                         node_id: their_node_id.clone(),
1704                                         msg: funding_msg,
1705                                 });
1706                                 e.insert(chan);
1707                         }
1708                 }
1709                 Ok(())
1710         }
1711
1712         fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1713                 let (funding_txo, user_id) = {
1714                         let mut channel_state = self.channel_state.lock().unwrap();
1715                         match channel_state.by_id.get_mut(&msg.channel_id) {
1716                                 Some(chan) => {
1717                                         if chan.get_their_node_id() != *their_node_id {
1718                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1719                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1720                                         }
1721                                         let chan_monitor = chan.funding_signed(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1722                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1723                                                 unimplemented!();
1724                                         }
1725                                         (chan.get_funding_txo().unwrap(), chan.get_user_id())
1726                                 },
1727                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1728                         }
1729                 };
1730                 let mut pending_events = self.pending_events.lock().unwrap();
1731                 pending_events.push(events::Event::FundingBroadcastSafe {
1732                         funding_txo: funding_txo,
1733                         user_channel_id: user_id,
1734                 });
1735                 Ok(())
1736         }
1737
1738         fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
1739                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1740                 let channel_state = channel_state_lock.borrow_parts();
1741                 match channel_state.by_id.get_mut(&msg.channel_id) {
1742                         Some(chan) => {
1743                                 if chan.get_their_node_id() != *their_node_id {
1744                                         //TODO: here and below MsgHandleErrInternal, #153 case
1745                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1746                                 }
1747                                 chan.funding_locked(&msg)
1748                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
1749                                 if let Some(announcement_sigs) = self.get_announcement_sigs(chan) {
1750                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1751                                                 node_id: their_node_id.clone(),
1752                                                 msg: announcement_sigs,
1753                                         });
1754                                 }
1755                                 Ok(())
1756                         },
1757                         None => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1758                 }
1759         }
1760
1761         fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
1762                 let (mut dropped_htlcs, chan_option) = {
1763                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1764                         let channel_state = channel_state_lock.borrow_parts();
1765
1766                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1767                                 hash_map::Entry::Occupied(mut chan_entry) => {
1768                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1769                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1770                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1771                                         }
1772                                         let (shutdown, closing_signed, dropped_htlcs) = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1773                                         if let Some(msg) = shutdown {
1774                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1775                                                         node_id: their_node_id.clone(),
1776                                                         msg,
1777                                                 });
1778                                         }
1779                                         if let Some(msg) = closing_signed {
1780                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1781                                                         node_id: their_node_id.clone(),
1782                                                         msg,
1783                                                 });
1784                                         }
1785                                         if chan_entry.get().is_shutdown() {
1786                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1787                                                         channel_state.short_to_id.remove(&short_id);
1788                                                 }
1789                                                 (dropped_htlcs, Some(chan_entry.remove_entry().1))
1790                                         } else { (dropped_htlcs, None) }
1791                                 },
1792                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1793                         }
1794                 };
1795                 for htlc_source in dropped_htlcs.drain(..) {
1796                         // unknown_next_peer...I dunno who that is anymore....
1797                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 10, data: Vec::new() });
1798                 }
1799                 if let Some(chan) = chan_option {
1800                         if let Ok(update) = self.get_channel_update(&chan) {
1801                                 let mut channel_state = self.channel_state.lock().unwrap();
1802                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1803                                         msg: update
1804                                 });
1805                         }
1806                 }
1807                 Ok(())
1808         }
1809
1810         fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
1811                 let (tx, chan_option) = {
1812                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1813                         let channel_state = channel_state_lock.borrow_parts();
1814                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1815                                 hash_map::Entry::Occupied(mut chan_entry) => {
1816                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1817                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1818                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1819                                         }
1820                                         let (closing_signed, tx) = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
1821                                         if let Some(msg) = closing_signed {
1822                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1823                                                         node_id: their_node_id.clone(),
1824                                                         msg,
1825                                                 });
1826                                         }
1827                                         if tx.is_some() {
1828                                                 // We're done with this channel, we've got a signed closing transaction and
1829                                                 // will send the closing_signed back to the remote peer upon return. This
1830                                                 // also implies there are no pending HTLCs left on the channel, so we can
1831                                                 // fully delete it from tracking (the channel monitor is still around to
1832                                                 // watch for old state broadcasts)!
1833                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1834                                                         channel_state.short_to_id.remove(&short_id);
1835                                                 }
1836                                                 (tx, Some(chan_entry.remove_entry().1))
1837                                         } else { (tx, None) }
1838                                 },
1839                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1840                         }
1841                 };
1842                 if let Some(broadcast_tx) = tx {
1843                         self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
1844                 }
1845                 if let Some(chan) = chan_option {
1846                         if let Ok(update) = self.get_channel_update(&chan) {
1847                                 let mut channel_state = self.channel_state.lock().unwrap();
1848                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1849                                         msg: update
1850                                 });
1851                         }
1852                 }
1853                 Ok(())
1854         }
1855
1856         fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
1857                 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
1858                 //determine the state of the payment based on our response/if we forward anything/the time
1859                 //we take to respond. We should take care to avoid allowing such an attack.
1860                 //
1861                 //TODO: There exists a further attack where a node may garble the onion data, forward it to
1862                 //us repeatedly garbled in different ways, and compare our error messages, which are
1863                 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
1864                 //but we should prevent it anyway.
1865
1866                 let (pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
1867                 let channel_state = channel_state_lock.borrow_parts();
1868
1869                 match channel_state.by_id.get_mut(&msg.channel_id) {
1870                         Some(chan) => {
1871                                 if chan.get_their_node_id() != *their_node_id {
1872                                         //TODO: here MsgHandleErrInternal, #153 case
1873                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1874                                 }
1875                                 if !chan.is_usable() {
1876                                         return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Channel not yet available for receiving HTLCs", action: Some(msgs::ErrorAction::IgnoreError)}));
1877                                 }
1878                                 chan.update_add_htlc(&msg, pending_forward_info).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))
1879                         },
1880                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1881                 }
1882         }
1883
1884         fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
1885                 let mut channel_state = self.channel_state.lock().unwrap();
1886                 let htlc_source = match channel_state.by_id.get_mut(&msg.channel_id) {
1887                         Some(chan) => {
1888                                 if chan.get_their_node_id() != *their_node_id {
1889                                         //TODO: here and below MsgHandleErrInternal, #153 case
1890                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1891                                 }
1892                                 chan.update_fulfill_htlc(&msg)
1893                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?.clone()
1894                         },
1895                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1896                 };
1897                 self.claim_funds_internal(channel_state, htlc_source, msg.payment_preimage.clone());
1898                 Ok(())
1899         }
1900
1901         // Process failure we got back from upstream on a payment we sent. Returns update and a boolean
1902         // indicating that the payment itself failed
1903         fn process_onion_failure(&self, htlc_source: &HTLCSource, mut packet_decrypted: Vec<u8>) -> (Option<msgs::HTLCFailChannelUpdate>, bool) {
1904                 if let &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } = htlc_source {
1905                         macro_rules! onion_failure_log {
1906                                 ( $error_code_textual: expr, $error_code: expr, $reported_name: expr, $reported_value: expr ) => {
1907                                         log_trace!(self, "{}({:#x}) {}({})", $error_code_textual, $error_code, $reported_name, $reported_value);
1908                                 };
1909                                 ( $error_code_textual: expr, $error_code: expr ) => {
1910                                         log_trace!(self, "{}({})", $error_code_textual, $error_code);
1911                                 };
1912                         }
1913
1914                         const BADONION: u16 = 0x8000;
1915                         const PERM: u16 = 0x4000;
1916                         const UPDATE: u16 = 0x1000;
1917
1918                         let mut res = None;
1919                         let mut htlc_msat = *first_hop_htlc_msat;
1920
1921                         // Handle packed channel/node updates for passing back for the route handler
1922                         Self::construct_onion_keys_callback(&self.secp_ctx, route, session_priv, |shared_secret, _, _, route_hop| {
1923                                 if res.is_some() { return; }
1924
1925                                 let incoming_htlc_msat = htlc_msat;
1926                                 let amt_to_forward = htlc_msat - route_hop.fee_msat;
1927                                 htlc_msat = amt_to_forward;
1928
1929                                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
1930
1931                                 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
1932                                 decryption_tmp.resize(packet_decrypted.len(), 0);
1933                                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
1934                                 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
1935                                 packet_decrypted = decryption_tmp;
1936
1937                                 let is_from_final_node = route.hops.last().unwrap().pubkey == route_hop.pubkey;
1938
1939                                 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::read(&mut Cursor::new(&packet_decrypted)) {
1940                                         let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
1941                                         let mut hmac = Hmac::new(Sha256::new(), &um);
1942                                         hmac.input(&err_packet.encode()[32..]);
1943                                         let mut calc_tag = [0u8; 32];
1944                                         hmac.raw_result(&mut calc_tag);
1945
1946                                         if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
1947                                                 if err_packet.failuremsg.len() < 2 {
1948                                                         // Useless packet that we can't use but it passed HMAC, so it
1949                                                         // definitely came from the peer in question
1950                                                         res = Some((None, !is_from_final_node));
1951                                                 } else {
1952                                                         let error_code = byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]);
1953
1954                                                         match error_code & 0xff {
1955                                                                 1|2|3 => {
1956                                                                         // either from an intermediate or final node
1957                                                                         //   invalid_realm(PERM|1),
1958                                                                         //   temporary_node_failure(NODE|2)
1959                                                                         //   permanent_node_failure(PERM|NODE|2)
1960                                                                         //   required_node_feature_mssing(PERM|NODE|3)
1961                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
1962                                                                                 node_id: route_hop.pubkey,
1963                                                                                 is_permanent: error_code & PERM == PERM,
1964                                                                         }), !(error_code & PERM == PERM && is_from_final_node)));
1965                                                                         // node returning invalid_realm is removed from network_map,
1966                                                                         // although NODE flag is not set, TODO: or remove channel only?
1967                                                                         // retry payment when removed node is not a final node
1968                                                                         return;
1969                                                                 },
1970                                                                 _ => {}
1971                                                         }
1972
1973                                                         if is_from_final_node {
1974                                                                 let payment_retryable = match error_code {
1975                                                                         c if c == PERM|15 => false, // unknown_payment_hash
1976                                                                         c if c == PERM|16 => false, // incorrect_payment_amount
1977                                                                         17 => true, // final_expiry_too_soon
1978                                                                         18 if err_packet.failuremsg.len() == 6 => { // final_incorrect_cltv_expiry
1979                                                                                 let _reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
1980                                                                                 true
1981                                                                         },
1982                                                                         19 if err_packet.failuremsg.len() == 10 => { // final_incorrect_htlc_amount
1983                                                                                 let _reported_incoming_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
1984                                                                                 true
1985                                                                         },
1986                                                                         _ => {
1987                                                                                 // A final node has sent us either an invalid code or an error_code that
1988                                                                                 // MUST be sent from the processing node, or the formmat of failuremsg
1989                                                                                 // does not coform to the spec.
1990                                                                                 // Remove it from the network map and don't may retry payment
1991                                                                                 res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
1992                                                                                         node_id: route_hop.pubkey,
1993                                                                                         is_permanent: true,
1994                                                                                 }), false));
1995                                                                                 return;
1996                                                                         }
1997                                                                 };
1998                                                                 res = Some((None, payment_retryable));
1999                                                                 return;
2000                                                         }
2001
2002                                                         // now, error_code should be only from the intermediate nodes
2003                                                         match error_code {
2004                                                                 _c if error_code & PERM == PERM => {
2005                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
2006                                                                                 short_channel_id: route_hop.short_channel_id,
2007                                                                                 is_permanent: true,
2008                                                                         }), false));
2009                                                                 },
2010                                                                 _c if error_code & UPDATE == UPDATE => {
2011                                                                         let offset = match error_code {
2012                                                                                 c if c == UPDATE|7  => 0, // temporary_channel_failure
2013                                                                                 c if c == UPDATE|11 => 8, // amount_below_minimum
2014                                                                                 c if c == UPDATE|12 => 8, // fee_insufficient
2015                                                                                 c if c == UPDATE|13 => 4, // incorrect_cltv_expiry
2016                                                                                 c if c == UPDATE|14 => 0, // expiry_too_soon
2017                                                                                 c if c == UPDATE|20 => 2, // channel_disabled
2018                                                                                 _ =>  {
2019                                                                                         // node sending unknown code
2020                                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2021                                                                                                 node_id: route_hop.pubkey,
2022                                                                                                 is_permanent: true,
2023                                                                                         }), false));
2024                                                                                         return;
2025                                                                                 }
2026                                                                         };
2027
2028                                                                         if err_packet.failuremsg.len() >= offset + 2 {
2029                                                                                 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[offset+2..offset+4]) as usize;
2030                                                                                 if err_packet.failuremsg.len() >= offset + 4 + update_len {
2031                                                                                         if let Ok(chan_update) = msgs::ChannelUpdate::read(&mut Cursor::new(&err_packet.failuremsg[offset + 4..offset + 4 + update_len])) {
2032                                                                                                 // if channel_update should NOT have caused the failure:
2033                                                                                                 // MAY treat the channel_update as invalid.
2034                                                                                                 let is_chan_update_invalid = match error_code {
2035                                                                                                         c if c == UPDATE|7 => { // temporary_channel_failure
2036                                                                                                                 false
2037                                                                                                         },
2038                                                                                                         c if c == UPDATE|11 => { // amount_below_minimum
2039                                                                                                                 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2040                                                                                                                 onion_failure_log!("amount_below_minimum", UPDATE|11, "htlc_msat", reported_htlc_msat);
2041                                                                                                                 incoming_htlc_msat > chan_update.contents.htlc_minimum_msat
2042                                                                                                         },
2043                                                                                                         c if c == UPDATE|12 => { // fee_insufficient
2044                                                                                                                 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2045                                                                                                                 let new_fee =  amt_to_forward.checked_mul(chan_update.contents.fee_proportional_millionths as u64).and_then(|prop_fee| { (prop_fee / 1000000).checked_add(chan_update.contents.fee_base_msat as u64) });
2046                                                                                                                 onion_failure_log!("fee_insufficient", UPDATE|12, "htlc_msat", reported_htlc_msat);
2047                                                                                                                 new_fee.is_none() || incoming_htlc_msat >= new_fee.unwrap() && incoming_htlc_msat >= amt_to_forward + new_fee.unwrap()
2048                                                                                                         }
2049                                                                                                         c if c == UPDATE|13 => { // incorrect_cltv_expiry
2050                                                                                                                 let reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
2051                                                                                                                 onion_failure_log!("incorrect_cltv_expiry", UPDATE|13, "cltv_expiry", reported_cltv_expiry);
2052                                                                                                                 route_hop.cltv_expiry_delta as u16 >= chan_update.contents.cltv_expiry_delta
2053                                                                                                         },
2054                                                                                                         c if c == UPDATE|20 => { // channel_disabled
2055                                                                                                                 let reported_flags = byte_utils::slice_to_be16(&err_packet.failuremsg[2..2+2]);
2056                                                                                                                 onion_failure_log!("channel_disabled", UPDATE|20, "flags", reported_flags);
2057                                                                                                                 chan_update.contents.flags & 0x01 == 0x01
2058                                                                                                         },
2059                                                                                                         c if c == UPDATE|21 => true, // expiry_too_far
2060                                                                                                         _ => { unreachable!(); },
2061                                                                                                 };
2062
2063                                                                                                 let msg = if is_chan_update_invalid { None } else {
2064                                                                                                         Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
2065                                                                                                                 msg: chan_update,
2066                                                                                                         })
2067                                                                                                 };
2068                                                                                                 res = Some((msg, true));
2069                                                                                                 return;
2070                                                                                         }
2071                                                                                 }
2072                                                                         }
2073                                                                 },
2074                                                                 _c if error_code & BADONION == BADONION => {
2075                                                                         //TODO
2076                                                                 },
2077                                                                 14 => { // expiry_too_soon
2078                                                                         res = Some((None, true));
2079                                                                         return;
2080                                                                 }
2081                                                                 _ => {
2082                                                                         // node sending unknown code
2083                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2084                                                                                 node_id: route_hop.pubkey,
2085                                                                                 is_permanent: true,
2086                                                                         }), false));
2087                                                                         return;
2088                                                                 }
2089                                                         }
2090                                                 }
2091                                         }
2092                                 }
2093                         }).expect("Route that we sent via spontaneously grew invalid keys in the middle of it?");
2094                         res.unwrap_or((None, true))
2095                 } else { ((None, true)) }
2096         }
2097
2098         fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2099                 let mut channel_state = self.channel_state.lock().unwrap();
2100                 match channel_state.by_id.get_mut(&msg.channel_id) {
2101                         Some(chan) => {
2102                                 if chan.get_their_node_id() != *their_node_id {
2103                                         //TODO: here and below MsgHandleErrInternal, #153 case
2104                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2105                                 }
2106                                 chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() })
2107                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))
2108                         },
2109                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2110                 }?;
2111                 Ok(())
2112         }
2113
2114         fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2115                 let mut channel_state = self.channel_state.lock().unwrap();
2116                 match channel_state.by_id.get_mut(&msg.channel_id) {
2117                         Some(chan) => {
2118                                 if chan.get_their_node_id() != *their_node_id {
2119                                         //TODO: here and below MsgHandleErrInternal, #153 case
2120                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2121                                 }
2122                                 if (msg.failure_code & 0x8000) != 0 {
2123                                         return Err(MsgHandleErrInternal::send_err_msg_close_chan("Got update_fail_malformed_htlc with BADONION set", msg.channel_id));
2124                                 }
2125                                 chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() })
2126                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2127                                 Ok(())
2128                         },
2129                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2130                 }
2131         }
2132
2133         fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2134                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2135                 let channel_state = channel_state_lock.borrow_parts();
2136                 match channel_state.by_id.get_mut(&msg.channel_id) {
2137                         Some(chan) => {
2138                                 if chan.get_their_node_id() != *their_node_id {
2139                                         //TODO: here and below MsgHandleErrInternal, #153 case
2140                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2141                                 }
2142                                 let (revoke_and_ack, commitment_signed, chan_monitor) = chan.commitment_signed(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
2143                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2144                                         unimplemented!();
2145                                 }
2146                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2147                                         node_id: their_node_id.clone(),
2148                                         msg: revoke_and_ack,
2149                                 });
2150                                 if let Some(msg) = commitment_signed {
2151                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2152                                                 node_id: their_node_id.clone(),
2153                                                 updates: msgs::CommitmentUpdate {
2154                                                         update_add_htlcs: Vec::new(),
2155                                                         update_fulfill_htlcs: Vec::new(),
2156                                                         update_fail_htlcs: Vec::new(),
2157                                                         update_fail_malformed_htlcs: Vec::new(),
2158                                                         update_fee: None,
2159                                                         commitment_signed: msg,
2160                                                 },
2161                                         });
2162                                 }
2163                                 Ok(())
2164                         },
2165                         None => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2166                 }
2167         }
2168
2169         #[inline]
2170         fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingForwardHTLCInfo, u64)>)]) {
2171                 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2172                         let mut forward_event = None;
2173                         if !pending_forwards.is_empty() {
2174                                 let mut channel_state = self.channel_state.lock().unwrap();
2175                                 if channel_state.forward_htlcs.is_empty() {
2176                                         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));
2177                                         channel_state.next_forward = forward_event.unwrap();
2178                                 }
2179                                 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2180                                         match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2181                                                 hash_map::Entry::Occupied(mut entry) => {
2182                                                         entry.get_mut().push(HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info });
2183                                                 },
2184                                                 hash_map::Entry::Vacant(entry) => {
2185                                                         entry.insert(vec!(HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info }));
2186                                                 }
2187                                         }
2188                                 }
2189                         }
2190                         match forward_event {
2191                                 Some(time) => {
2192                                         let mut pending_events = self.pending_events.lock().unwrap();
2193                                         pending_events.push(events::Event::PendingHTLCsForwardable {
2194                                                 time_forwardable: time
2195                                         });
2196                                 }
2197                                 None => {},
2198                         }
2199                 }
2200         }
2201
2202         fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2203                 let (pending_forwards, mut pending_failures, short_channel_id) = {
2204                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2205                         let channel_state = channel_state_lock.borrow_parts();
2206                         match channel_state.by_id.get_mut(&msg.channel_id) {
2207                                 Some(chan) => {
2208                                         if chan.get_their_node_id() != *their_node_id {
2209                                                 //TODO: here and below MsgHandleErrInternal, #153 case
2210                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2211                                         }
2212                                         let (commitment_update, pending_forwards, pending_failures, chan_monitor) = chan.revoke_and_ack(&msg).map_err(|e| MsgHandleErrInternal::from_maybe_close(e))?;
2213                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2214                                                 unimplemented!();
2215                                         }
2216                                         if let Some(updates) = commitment_update {
2217                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2218                                                         node_id: their_node_id.clone(),
2219                                                         updates,
2220                                                 });
2221                                         }
2222                                         (pending_forwards, pending_failures, chan.get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2223                                 },
2224                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2225                         }
2226                 };
2227                 for failure in pending_failures.drain(..) {
2228                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2229                 }
2230                 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2231
2232                 Ok(())
2233         }
2234
2235         fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2236                 let mut channel_state = self.channel_state.lock().unwrap();
2237                 match channel_state.by_id.get_mut(&msg.channel_id) {
2238                         Some(chan) => {
2239                                 if chan.get_their_node_id() != *their_node_id {
2240                                         //TODO: here and below MsgHandleErrInternal, #153 case
2241                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2242                                 }
2243                                 chan.update_fee(&*self.fee_estimator, &msg).map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))
2244                         },
2245                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2246                 }
2247         }
2248
2249         fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2250                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2251                 let channel_state = channel_state_lock.borrow_parts();
2252
2253                 match channel_state.by_id.get_mut(&msg.channel_id) {
2254                         Some(chan) => {
2255                                 if chan.get_their_node_id() != *their_node_id {
2256                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2257                                 }
2258                                 if !chan.is_usable() {
2259                                         return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Got an announcement_signatures before we were ready for it", action: Some(msgs::ErrorAction::IgnoreError)}));
2260                                 }
2261
2262                                 let our_node_id = self.get_our_node_id();
2263                                 let (announcement, our_bitcoin_sig) = chan.get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone())
2264                                         .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2265
2266                                 let were_node_one = announcement.node_id_1 == our_node_id;
2267                                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
2268                                 let bad_sig_action = MsgHandleErrInternal::send_err_msg_close_chan("Bad announcement_signatures node_signature", msg.channel_id);
2269                                 secp_call!(self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }), bad_sig_action);
2270                                 secp_call!(self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }), bad_sig_action);
2271
2272                                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2273
2274                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2275                                         msg: msgs::ChannelAnnouncement {
2276                                                 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2277                                                 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2278                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2279                                                 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2280                                                 contents: announcement,
2281                                         },
2282                                         update_msg: self.get_channel_update(chan).unwrap(), // can only fail if we're not in a ready state
2283                                 });
2284                         },
2285                         None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2286                 }
2287                 Ok(())
2288         }
2289
2290         fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder), MsgHandleErrInternal> {
2291                 let res = {
2292                         let mut channel_state = self.channel_state.lock().unwrap();
2293                         match channel_state.by_id.get_mut(&msg.channel_id) {
2294                                 Some(chan) => {
2295                                         if chan.get_their_node_id() != *their_node_id {
2296                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2297                                         }
2298                                         let (funding_locked, revoke_and_ack, commitment_update, channel_monitor, order) = chan.channel_reestablish(msg)
2299                                                 .map_err(|e| MsgHandleErrInternal::from_chan_maybe_close(e, msg.channel_id))?;
2300                                         if let Some(monitor) = channel_monitor {
2301                                                 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
2302                                                         unimplemented!();
2303                                                 }
2304                                         }
2305                                         Ok((funding_locked, revoke_and_ack, commitment_update, order))
2306                                 },
2307                                 None => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2308                         }
2309                 };
2310
2311                 res
2312         }
2313
2314         /// Begin Update fee process. Allowed only on an outbound channel.
2315         /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2316         /// PeerManager::process_events afterwards.
2317         /// Note: This API is likely to change!
2318         #[doc(hidden)]
2319         pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2320                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2321                 let channel_state = channel_state_lock.borrow_parts();
2322
2323                 match channel_state.by_id.get_mut(&channel_id) {
2324                         None => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2325                         Some(chan) => {
2326                                 if !chan.is_outbound() {
2327                                         return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2328                                 }
2329                                 if chan.is_awaiting_monitor_update() {
2330                                         return Err(APIError::MonitorUpdateFailed);
2331                                 }
2332                                 if !chan.is_live() {
2333                                         return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2334                                 }
2335                                 if let Some((update_fee, commitment_signed, chan_monitor)) = chan.send_update_fee_and_commit(feerate_per_kw).map_err(|e| APIError::APIMisuseError{err: e.err})? {
2336                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2337                                                 unimplemented!();
2338                                         }
2339                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2340                                                 node_id: chan.get_their_node_id(),
2341                                                 updates: msgs::CommitmentUpdate {
2342                                                         update_add_htlcs: Vec::new(),
2343                                                         update_fulfill_htlcs: Vec::new(),
2344                                                         update_fail_htlcs: Vec::new(),
2345                                                         update_fail_malformed_htlcs: Vec::new(),
2346                                                         update_fee: Some(update_fee),
2347                                                         commitment_signed,
2348                                                 },
2349                                         });
2350                                 }
2351                         },
2352                 }
2353                 Ok(())
2354         }
2355 }
2356
2357 impl events::MessageSendEventsProvider for ChannelManager {
2358         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2359                 let mut ret = Vec::new();
2360                 let mut channel_state = self.channel_state.lock().unwrap();
2361                 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2362                 ret
2363         }
2364 }
2365
2366 impl events::EventsProvider for ChannelManager {
2367         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2368                 let mut ret = Vec::new();
2369                 let mut pending_events = self.pending_events.lock().unwrap();
2370                 mem::swap(&mut ret, &mut *pending_events);
2371                 ret
2372         }
2373 }
2374
2375 impl ChainListener for ChannelManager {
2376         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2377                 let mut failed_channels = Vec::new();
2378                 {
2379                         let mut channel_lock = self.channel_state.lock().unwrap();
2380                         let channel_state = channel_lock.borrow_parts();
2381                         let short_to_id = channel_state.short_to_id;
2382                         let pending_msg_events = channel_state.pending_msg_events;
2383                         channel_state.by_id.retain(|_, channel| {
2384                                 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2385                                 if let Ok(Some(funding_locked)) = chan_res {
2386                                         pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2387                                                 node_id: channel.get_their_node_id(),
2388                                                 msg: funding_locked,
2389                                         });
2390                                         if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2391                                                 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2392                                                         node_id: channel.get_their_node_id(),
2393                                                         msg: announcement_sigs,
2394                                                 });
2395                                         }
2396                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2397                                 } else if let Err(e) = chan_res {
2398                                         pending_msg_events.push(events::MessageSendEvent::HandleError {
2399                                                 node_id: channel.get_their_node_id(),
2400                                                 action: e.action,
2401                                         });
2402                                         if channel.is_shutdown() {
2403                                                 return false;
2404                                         }
2405                                 }
2406                                 if let Some(funding_txo) = channel.get_funding_txo() {
2407                                         for tx in txn_matched {
2408                                                 for inp in tx.input.iter() {
2409                                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2410                                                                 if let Some(short_id) = channel.get_short_channel_id() {
2411                                                                         short_to_id.remove(&short_id);
2412                                                                 }
2413                                                                 // It looks like our counterparty went on-chain. We go ahead and
2414                                                                 // broadcast our latest local state as well here, just in case its
2415                                                                 // some kind of SPV attack, though we expect these to be dropped.
2416                                                                 failed_channels.push(channel.force_shutdown());
2417                                                                 if let Ok(update) = self.get_channel_update(&channel) {
2418                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2419                                                                                 msg: update
2420                                                                         });
2421                                                                 }
2422                                                                 return false;
2423                                                         }
2424                                                 }
2425                                         }
2426                                 }
2427                                 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2428                                         if let Some(short_id) = channel.get_short_channel_id() {
2429                                                 short_to_id.remove(&short_id);
2430                                         }
2431                                         failed_channels.push(channel.force_shutdown());
2432                                         // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2433                                         // the latest local tx for us, so we should skip that here (it doesn't really
2434                                         // hurt anything, but does make tests a bit simpler).
2435                                         failed_channels.last_mut().unwrap().0 = Vec::new();
2436                                         if let Ok(update) = self.get_channel_update(&channel) {
2437                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2438                                                         msg: update
2439                                                 });
2440                                         }
2441                                         return false;
2442                                 }
2443                                 true
2444                         });
2445                 }
2446                 for failure in failed_channels.drain(..) {
2447                         self.finish_force_close_channel(failure);
2448                 }
2449                 self.latest_block_height.store(height as usize, Ordering::Release);
2450         }
2451
2452         /// We force-close the channel without letting our counterparty participate in the shutdown
2453         fn block_disconnected(&self, header: &BlockHeader) {
2454                 let mut failed_channels = Vec::new();
2455                 {
2456                         let mut channel_lock = self.channel_state.lock().unwrap();
2457                         let channel_state = channel_lock.borrow_parts();
2458                         let short_to_id = channel_state.short_to_id;
2459                         let pending_msg_events = channel_state.pending_msg_events;
2460                         channel_state.by_id.retain(|_,  v| {
2461                                 if v.block_disconnected(header) {
2462                                         if let Some(short_id) = v.get_short_channel_id() {
2463                                                 short_to_id.remove(&short_id);
2464                                         }
2465                                         failed_channels.push(v.force_shutdown());
2466                                         if let Ok(update) = self.get_channel_update(&v) {
2467                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2468                                                         msg: update
2469                                                 });
2470                                         }
2471                                         false
2472                                 } else {
2473                                         true
2474                                 }
2475                         });
2476                 }
2477                 for failure in failed_channels.drain(..) {
2478                         self.finish_force_close_channel(failure);
2479                 }
2480                 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2481         }
2482 }
2483
2484 macro_rules! handle_error {
2485         ($self: ident, $internal: expr, $their_node_id: expr) => {
2486                 match $internal {
2487                         Ok(msg) => Ok(msg),
2488                         Err(MsgHandleErrInternal { err, needs_channel_force_close }) => {
2489                                 if needs_channel_force_close {
2490                                         match &err.action {
2491                                                 &Some(msgs::ErrorAction::DisconnectPeer { msg: Some(ref msg) }) => {
2492                                                         if msg.channel_id == [0; 32] {
2493                                                                 $self.peer_disconnected(&$their_node_id, true);
2494                                                         } else {
2495                                                                 $self.force_close_channel(&msg.channel_id);
2496                                                         }
2497                                                 },
2498                                                 &Some(msgs::ErrorAction::DisconnectPeer { msg: None }) => {},
2499                                                 &Some(msgs::ErrorAction::IgnoreError) => {},
2500                                                 &Some(msgs::ErrorAction::SendErrorMessage { ref msg }) => {
2501                                                         if msg.channel_id == [0; 32] {
2502                                                                 $self.peer_disconnected(&$their_node_id, true);
2503                                                         } else {
2504                                                                 $self.force_close_channel(&msg.channel_id);
2505                                                         }
2506                                                 },
2507                                                 &None => {},
2508                                         }
2509                                 }
2510                                 Err(err)
2511                         },
2512                 }
2513         }
2514 }
2515
2516 impl ChannelMessageHandler for ChannelManager {
2517         //TODO: Handle errors and close channel (or so)
2518         fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), HandleError> {
2519                 handle_error!(self, self.internal_open_channel(their_node_id, msg), their_node_id)
2520         }
2521
2522         fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
2523                 handle_error!(self, self.internal_accept_channel(their_node_id, msg), their_node_id)
2524         }
2525
2526         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), HandleError> {
2527                 handle_error!(self, self.internal_funding_created(their_node_id, msg), their_node_id)
2528         }
2529
2530         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
2531                 handle_error!(self, self.internal_funding_signed(their_node_id, msg), their_node_id)
2532         }
2533
2534         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), HandleError> {
2535                 handle_error!(self, self.internal_funding_locked(their_node_id, msg), their_node_id)
2536         }
2537
2538         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), HandleError> {
2539                 handle_error!(self, self.internal_shutdown(their_node_id, msg), their_node_id)
2540         }
2541
2542         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), HandleError> {
2543                 handle_error!(self, self.internal_closing_signed(their_node_id, msg), their_node_id)
2544         }
2545
2546         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
2547                 handle_error!(self, self.internal_update_add_htlc(their_node_id, msg), their_node_id)
2548         }
2549
2550         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
2551                 handle_error!(self, self.internal_update_fulfill_htlc(their_node_id, msg), their_node_id)
2552         }
2553
2554         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), HandleError> {
2555                 handle_error!(self, self.internal_update_fail_htlc(their_node_id, msg), their_node_id)
2556         }
2557
2558         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
2559                 handle_error!(self, self.internal_update_fail_malformed_htlc(their_node_id, msg), their_node_id)
2560         }
2561
2562         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), HandleError> {
2563                 handle_error!(self, self.internal_commitment_signed(their_node_id, msg), their_node_id)
2564         }
2565
2566         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), HandleError> {
2567                 handle_error!(self, self.internal_revoke_and_ack(their_node_id, msg), their_node_id)
2568         }
2569
2570         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
2571                 handle_error!(self, self.internal_update_fee(their_node_id, msg), their_node_id)
2572         }
2573
2574         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
2575                 handle_error!(self, self.internal_announcement_signatures(their_node_id, msg), their_node_id)
2576         }
2577
2578         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(Option<msgs::FundingLocked>, Option<msgs::RevokeAndACK>, Option<msgs::CommitmentUpdate>, RAACommitmentOrder), HandleError> {
2579                 handle_error!(self, self.internal_channel_reestablish(their_node_id, msg), their_node_id)
2580         }
2581
2582         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2583                 let mut failed_channels = Vec::new();
2584                 let mut failed_payments = Vec::new();
2585                 {
2586                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2587                         let channel_state = channel_state_lock.borrow_parts();
2588                         let short_to_id = channel_state.short_to_id;
2589                         let pending_msg_events = channel_state.pending_msg_events;
2590                         if no_connection_possible {
2591                                 channel_state.by_id.retain(|_, chan| {
2592                                         if chan.get_their_node_id() == *their_node_id {
2593                                                 if let Some(short_id) = chan.get_short_channel_id() {
2594                                                         short_to_id.remove(&short_id);
2595                                                 }
2596                                                 failed_channels.push(chan.force_shutdown());
2597                                                 if let Ok(update) = self.get_channel_update(&chan) {
2598                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2599                                                                 msg: update
2600                                                         });
2601                                                 }
2602                                                 false
2603                                         } else {
2604                                                 true
2605                                         }
2606                                 });
2607                         } else {
2608                                 channel_state.by_id.retain(|_, chan| {
2609                                         if chan.get_their_node_id() == *their_node_id {
2610                                                 //TODO: mark channel disabled (and maybe announce such after a timeout).
2611                                                 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2612                                                 if !failed_adds.is_empty() {
2613                                                         let chan_update = self.get_channel_update(&chan).map(|u| u.encode_with_len()).unwrap(); // Cannot add/recv HTLCs before we have a short_id so unwrap is safe
2614                                                         failed_payments.push((chan_update, failed_adds));
2615                                                 }
2616                                                 if chan.is_shutdown() {
2617                                                         if let Some(short_id) = chan.get_short_channel_id() {
2618                                                                 short_to_id.remove(&short_id);
2619                                                         }
2620                                                         return false;
2621                                                 }
2622                                         }
2623                                         true
2624                                 })
2625                         }
2626                 }
2627                 for failure in failed_channels.drain(..) {
2628                         self.finish_force_close_channel(failure);
2629                 }
2630                 for (chan_update, mut htlc_sources) in failed_payments {
2631                         for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2632                                 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2633                         }
2634                 }
2635         }
2636
2637         fn peer_connected(&self, their_node_id: &PublicKey) -> Vec<msgs::ChannelReestablish> {
2638                 let mut res = Vec::new();
2639                 let mut channel_state = self.channel_state.lock().unwrap();
2640                 channel_state.by_id.retain(|_, chan| {
2641                         if chan.get_their_node_id() == *their_node_id {
2642                                 if !chan.have_received_message() {
2643                                         // If we created this (outbound) channel while we were disconnected from the
2644                                         // peer we probably failed to send the open_channel message, which is now
2645                                         // lost. We can't have had anything pending related to this channel, so we just
2646                                         // drop it.
2647                                         false
2648                                 } else {
2649                                         res.push(chan.get_channel_reestablish());
2650                                         true
2651                                 }
2652                         } else { true }
2653                 });
2654                 //TODO: Also re-broadcast announcement_signatures
2655                 res
2656         }
2657
2658         fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2659                 if msg.channel_id == [0; 32] {
2660                         for chan in self.list_channels() {
2661                                 if chan.remote_network_id == *their_node_id {
2662                                         self.force_close_channel(&chan.channel_id);
2663                                 }
2664                         }
2665                 } else {
2666                         self.force_close_channel(&msg.channel_id);
2667                 }
2668         }
2669 }
2670
2671 #[cfg(test)]
2672 mod tests {
2673         use chain::chaininterface;
2674         use chain::transaction::OutPoint;
2675         use chain::chaininterface::ChainListener;
2676         use chain::keysinterface::KeysInterface;
2677         use chain::keysinterface;
2678         use ln::channelmanager::{ChannelManager,OnionKeys,PaymentFailReason};
2679         use ln::channelmonitor::{ChannelMonitorUpdateErr, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS};
2680         use ln::router::{Route, RouteHop, Router};
2681         use ln::msgs;
2682         use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
2683         use util::test_utils;
2684         use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
2685         use util::errors::APIError;
2686         use util::logger::Logger;
2687         use util::ser::Writeable;
2688
2689         use bitcoin::util::hash::Sha256dHash;
2690         use bitcoin::blockdata::block::{Block, BlockHeader};
2691         use bitcoin::blockdata::transaction::{Transaction, TxOut};
2692         use bitcoin::blockdata::constants::genesis_block;
2693         use bitcoin::network::constants::Network;
2694         use bitcoin::network::serialize::serialize;
2695         use bitcoin::network::serialize::BitcoinHash;
2696
2697         use hex;
2698
2699         use secp256k1::{Secp256k1, Message};
2700         use secp256k1::key::{PublicKey,SecretKey};
2701
2702         use crypto::sha2::Sha256;
2703         use crypto::digest::Digest;
2704
2705         use rand::{thread_rng,Rng};
2706
2707         use std::cell::RefCell;
2708         use std::collections::{BTreeSet, HashMap};
2709         use std::default::Default;
2710         use std::rc::Rc;
2711         use std::sync::{Arc, Mutex};
2712         use std::sync::atomic::Ordering;
2713         use std::time::Instant;
2714         use std::mem;
2715
2716         fn build_test_onion_keys() -> Vec<OnionKeys> {
2717                 // Keys from BOLT 4, used in both test vector tests
2718                 let secp_ctx = Secp256k1::new();
2719
2720                 let route = Route {
2721                         hops: vec!(
2722                                         RouteHop {
2723                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
2724                                                 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
2725                                         },
2726                                         RouteHop {
2727                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
2728                                                 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
2729                                         },
2730                                         RouteHop {
2731                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
2732                                                 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
2733                                         },
2734                                         RouteHop {
2735                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
2736                                                 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
2737                                         },
2738                                         RouteHop {
2739                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
2740                                                 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
2741                                         },
2742                         ),
2743                 };
2744
2745                 let session_priv = SecretKey::from_slice(&secp_ctx, &hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
2746
2747                 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
2748                 assert_eq!(onion_keys.len(), route.hops.len());
2749                 onion_keys
2750         }
2751
2752         #[test]
2753         fn onion_vectors() {
2754                 // Packet creation test vectors from BOLT 4
2755                 let onion_keys = build_test_onion_keys();
2756
2757                 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
2758                 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
2759                 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
2760                 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
2761                 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
2762
2763                 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
2764                 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
2765                 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
2766                 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
2767                 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
2768
2769                 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
2770                 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
2771                 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
2772                 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
2773                 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
2774
2775                 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
2776                 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
2777                 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
2778                 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
2779                 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
2780
2781                 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
2782                 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
2783                 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
2784                 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
2785                 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
2786
2787                 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
2788                 let payloads = vec!(
2789                         msgs::OnionHopData {
2790                                 realm: 0,
2791                                 data: msgs::OnionRealm0HopData {
2792                                         short_channel_id: 0,
2793                                         amt_to_forward: 0,
2794                                         outgoing_cltv_value: 0,
2795                                 },
2796                                 hmac: [0; 32],
2797                         },
2798                         msgs::OnionHopData {
2799                                 realm: 0,
2800                                 data: msgs::OnionRealm0HopData {
2801                                         short_channel_id: 0x0101010101010101,
2802                                         amt_to_forward: 0x0100000001,
2803                                         outgoing_cltv_value: 0,
2804                                 },
2805                                 hmac: [0; 32],
2806                         },
2807                         msgs::OnionHopData {
2808                                 realm: 0,
2809                                 data: msgs::OnionRealm0HopData {
2810                                         short_channel_id: 0x0202020202020202,
2811                                         amt_to_forward: 0x0200000002,
2812                                         outgoing_cltv_value: 0,
2813                                 },
2814                                 hmac: [0; 32],
2815                         },
2816                         msgs::OnionHopData {
2817                                 realm: 0,
2818                                 data: msgs::OnionRealm0HopData {
2819                                         short_channel_id: 0x0303030303030303,
2820                                         amt_to_forward: 0x0300000003,
2821                                         outgoing_cltv_value: 0,
2822                                 },
2823                                 hmac: [0; 32],
2824                         },
2825                         msgs::OnionHopData {
2826                                 realm: 0,
2827                                 data: msgs::OnionRealm0HopData {
2828                                         short_channel_id: 0x0404040404040404,
2829                                         amt_to_forward: 0x0400000004,
2830                                         outgoing_cltv_value: 0,
2831                                 },
2832                                 hmac: [0; 32],
2833                         },
2834                 );
2835
2836                 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, &[0x42; 32]);
2837                 // Just check the final packet encoding, as it includes all the per-hop vectors in it
2838                 // anyway...
2839                 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
2840         }
2841
2842         #[test]
2843         fn test_failure_packet_onion() {
2844                 // Returning Errors test vectors from BOLT 4
2845
2846                 let onion_keys = build_test_onion_keys();
2847                 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret, 0x2002, &[0; 0]);
2848                 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
2849
2850                 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret, &onion_error.encode()[..]);
2851                 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
2852
2853                 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret, &onion_packet_1.data[..]);
2854                 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
2855
2856                 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret, &onion_packet_2.data[..]);
2857                 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
2858
2859                 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret, &onion_packet_3.data[..]);
2860                 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
2861
2862                 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret, &onion_packet_4.data[..]);
2863                 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
2864         }
2865
2866         fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
2867                 assert!(chain.does_match_tx(tx));
2868                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2869                 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
2870                 for i in 2..100 {
2871                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
2872                         chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
2873                 }
2874         }
2875
2876         struct Node {
2877                 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
2878                 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
2879                 chan_monitor: Arc<test_utils::TestChannelMonitor>,
2880                 node: Arc<ChannelManager>,
2881                 router: Router,
2882                 network_payment_count: Rc<RefCell<u8>>,
2883                 network_chan_count: Rc<RefCell<u32>>,
2884         }
2885         impl Drop for Node {
2886                 fn drop(&mut self) {
2887                         if !::std::thread::panicking() {
2888                                 // Check that we processed all pending events
2889                                 assert_eq!(self.node.get_and_clear_pending_msg_events().len(), 0);
2890                                 assert_eq!(self.node.get_and_clear_pending_events().len(), 0);
2891                                 assert_eq!(self.chan_monitor.added_monitors.lock().unwrap().len(), 0);
2892                         }
2893                 }
2894         }
2895
2896         fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2897                 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
2898         }
2899
2900         fn create_chan_between_nodes_with_value(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
2901                 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
2902                 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
2903                 (announcement, as_update, bs_update, channel_id, tx)
2904         }
2905
2906         macro_rules! get_revoke_commit_msgs {
2907                 ($node: expr, $node_id: expr) => {
2908                         {
2909                                 let events = $node.node.get_and_clear_pending_msg_events();
2910                                 assert_eq!(events.len(), 2);
2911                                 (match events[0] {
2912                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
2913                                                 assert_eq!(*node_id, $node_id);
2914                                                 (*msg).clone()
2915                                         },
2916                                         _ => panic!("Unexpected event"),
2917                                 }, match events[1] {
2918                                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2919                                                 assert_eq!(*node_id, $node_id);
2920                                                 assert!(updates.update_add_htlcs.is_empty());
2921                                                 assert!(updates.update_fulfill_htlcs.is_empty());
2922                                                 assert!(updates.update_fail_htlcs.is_empty());
2923                                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
2924                                                 assert!(updates.update_fee.is_none());
2925                                                 updates.commitment_signed.clone()
2926                                         },
2927                                         _ => panic!("Unexpected event"),
2928                                 })
2929                         }
2930                 }
2931         }
2932
2933         macro_rules! get_event_msg {
2934                 ($node: expr, $event_type: path, $node_id: expr) => {
2935                         {
2936                                 let events = $node.node.get_and_clear_pending_msg_events();
2937                                 assert_eq!(events.len(), 1);
2938                                 match events[0] {
2939                                         $event_type { ref node_id, ref msg } => {
2940                                                 assert_eq!(*node_id, $node_id);
2941                                                 (*msg).clone()
2942                                         },
2943                                         _ => panic!("Unexpected event"),
2944                                 }
2945                         }
2946                 }
2947         }
2948
2949         macro_rules! get_htlc_update_msgs {
2950                 ($node: expr, $node_id: expr) => {
2951                         {
2952                                 let events = $node.node.get_and_clear_pending_msg_events();
2953                                 assert_eq!(events.len(), 1);
2954                                 match events[0] {
2955                                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
2956                                                 assert_eq!(*node_id, $node_id);
2957                                                 (*updates).clone()
2958                                         },
2959                                         _ => panic!("Unexpected event"),
2960                                 }
2961                         }
2962                 }
2963         }
2964
2965         fn create_chan_between_nodes_with_value_init(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> Transaction {
2966                 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
2967                 node_b.node.handle_open_channel(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendOpenChannel, node_b.node.get_our_node_id())).unwrap();
2968                 node_a.node.handle_accept_channel(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendAcceptChannel, node_a.node.get_our_node_id())).unwrap();
2969
2970                 let chan_id = *node_a.network_chan_count.borrow();
2971                 let tx;
2972                 let funding_output;
2973
2974                 let events_2 = node_a.node.get_and_clear_pending_events();
2975                 assert_eq!(events_2.len(), 1);
2976                 match events_2[0] {
2977                         Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
2978                                 assert_eq!(*channel_value_satoshis, channel_value);
2979                                 assert_eq!(user_channel_id, 42);
2980
2981                                 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
2982                                         value: *channel_value_satoshis, script_pubkey: output_script.clone(),
2983                                 }]};
2984                                 funding_output = OutPoint::new(Sha256dHash::from_data(&serialize(&tx).unwrap()[..]), 0);
2985
2986                                 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
2987                                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
2988                                 assert_eq!(added_monitors.len(), 1);
2989                                 assert_eq!(added_monitors[0].0, funding_output);
2990                                 added_monitors.clear();
2991                         },
2992                         _ => panic!("Unexpected event"),
2993                 }
2994
2995                 node_b.node.handle_funding_created(&node_a.node.get_our_node_id(), &get_event_msg!(node_a, MessageSendEvent::SendFundingCreated, node_b.node.get_our_node_id())).unwrap();
2996                 {
2997                         let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
2998                         assert_eq!(added_monitors.len(), 1);
2999                         assert_eq!(added_monitors[0].0, funding_output);
3000                         added_monitors.clear();
3001                 }
3002
3003                 node_a.node.handle_funding_signed(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingSigned, node_a.node.get_our_node_id())).unwrap();
3004                 {
3005                         let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
3006                         assert_eq!(added_monitors.len(), 1);
3007                         assert_eq!(added_monitors[0].0, funding_output);
3008                         added_monitors.clear();
3009                 }
3010
3011                 let events_4 = node_a.node.get_and_clear_pending_events();
3012                 assert_eq!(events_4.len(), 1);
3013                 match events_4[0] {
3014                         Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
3015                                 assert_eq!(user_channel_id, 42);
3016                                 assert_eq!(*funding_txo, funding_output);
3017                         },
3018                         _ => panic!("Unexpected event"),
3019                 };
3020
3021                 tx
3022         }
3023
3024         fn create_chan_between_nodes_with_value_confirm(node_a: &Node, node_b: &Node, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
3025                 confirm_transaction(&node_b.chain_monitor, &tx, tx.version);
3026                 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &get_event_msg!(node_b, MessageSendEvent::SendFundingLocked, node_a.node.get_our_node_id())).unwrap();
3027
3028                 let channel_id;
3029
3030                 confirm_transaction(&node_a.chain_monitor, &tx, tx.version);
3031                 let events_6 = node_a.node.get_and_clear_pending_msg_events();
3032                 assert_eq!(events_6.len(), 2);
3033                 ((match events_6[0] {
3034                         MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3035                                 channel_id = msg.channel_id.clone();
3036                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
3037                                 msg.clone()
3038                         },
3039                         _ => panic!("Unexpected event"),
3040                 }, match events_6[1] {
3041                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3042                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
3043                                 msg.clone()
3044                         },
3045                         _ => panic!("Unexpected event"),
3046                 }), channel_id)
3047         }
3048
3049         fn create_chan_between_nodes_with_value_a(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32], Transaction) {
3050                 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
3051                 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
3052                 (msgs, chan_id, tx)
3053         }
3054
3055         fn create_chan_between_nodes_with_value_b(node_a: &Node, node_b: &Node, as_funding_msgs: &(msgs::FundingLocked, msgs::AnnouncementSignatures)) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate) {
3056                 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0).unwrap();
3057                 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
3058                 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1).unwrap();
3059
3060                 let events_7 = node_b.node.get_and_clear_pending_msg_events();
3061                 assert_eq!(events_7.len(), 1);
3062                 let (announcement, bs_update) = match events_7[0] {
3063                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3064                                 (msg, update_msg)
3065                         },
3066                         _ => panic!("Unexpected event"),
3067                 };
3068
3069                 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs).unwrap();
3070                 let events_8 = node_a.node.get_and_clear_pending_msg_events();
3071                 assert_eq!(events_8.len(), 1);
3072                 let as_update = match events_8[0] {
3073                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3074                                 assert!(*announcement == *msg);
3075                                 update_msg
3076                         },
3077                         _ => panic!("Unexpected event"),
3078                 };
3079
3080                 *node_a.network_chan_count.borrow_mut() += 1;
3081
3082                 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
3083         }
3084
3085         fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3086                 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
3087         }
3088
3089         fn create_announced_chan_between_nodes_with_value(nodes: &Vec<Node>, a: usize, b: usize, channel_value: u64, push_msat: u64) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3090                 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
3091                 for node in nodes {
3092                         assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
3093                         node.router.handle_channel_update(&chan_announcement.1).unwrap();
3094                         node.router.handle_channel_update(&chan_announcement.2).unwrap();
3095                 }
3096                 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
3097         }
3098
3099         macro_rules! check_spends {
3100                 ($tx: expr, $spends_tx: expr) => {
3101                         {
3102                                 let mut funding_tx_map = HashMap::new();
3103                                 let spends_tx = $spends_tx;
3104                                 funding_tx_map.insert(spends_tx.txid(), spends_tx);
3105                                 $tx.verify(&funding_tx_map).unwrap();
3106                         }
3107                 }
3108         }
3109
3110         fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate) {
3111                 let (node_a, broadcaster_a, struct_a) = if close_inbound_first { (&inbound_node.node, &inbound_node.tx_broadcaster, inbound_node) } else { (&outbound_node.node, &outbound_node.tx_broadcaster, outbound_node) };
3112                 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
3113                 let (tx_a, tx_b);
3114
3115                 node_a.close_channel(channel_id).unwrap();
3116                 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id())).unwrap();
3117
3118                 let events_1 = node_b.get_and_clear_pending_msg_events();
3119                 assert!(events_1.len() >= 1);
3120                 let shutdown_b = match events_1[0] {
3121                         MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
3122                                 assert_eq!(node_id, &node_a.get_our_node_id());
3123                                 msg.clone()
3124                         },
3125                         _ => panic!("Unexpected event"),
3126                 };
3127
3128                 let closing_signed_b = if !close_inbound_first {
3129                         assert_eq!(events_1.len(), 1);
3130                         None
3131                 } else {
3132                         Some(match events_1[1] {
3133                                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
3134                                         assert_eq!(node_id, &node_a.get_our_node_id());
3135                                         msg.clone()
3136                                 },
3137                                 _ => panic!("Unexpected event"),
3138                         })
3139                 };
3140
3141                 macro_rules! get_closing_signed_broadcast {
3142                         ($node: expr, $dest_pubkey: expr) => {
3143                                 {
3144                                         let events = $node.get_and_clear_pending_msg_events();
3145                                         assert!(events.len() == 1 || events.len() == 2);
3146                                         (match events[events.len() - 1] {
3147                                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3148                                                         msg.clone()
3149                                                 },
3150                                                 _ => panic!("Unexpected event"),
3151                                         }, if events.len() == 2 {
3152                                                 match events[0] {
3153                                                         MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
3154                                                                 assert_eq!(*node_id, $dest_pubkey);
3155                                                                 Some(msg.clone())
3156                                                         },
3157                                                         _ => panic!("Unexpected event"),
3158                                                 }
3159                                         } else { None })
3160                                 }
3161                         }
3162                 }
3163
3164                 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b).unwrap();
3165                 let (as_update, bs_update) = if close_inbound_first {
3166                         assert!(node_a.get_and_clear_pending_msg_events().is_empty());
3167                         node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
3168                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
3169                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
3170                         let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
3171
3172                         node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
3173                         let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
3174                         assert!(none_b.is_none());
3175                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
3176                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
3177                         (as_update, bs_update)
3178                 } else {
3179                         let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
3180
3181                         node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a).unwrap();
3182                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
3183                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
3184                         let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
3185
3186                         node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
3187                         let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
3188                         assert!(none_a.is_none());
3189                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
3190                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
3191                         (as_update, bs_update)
3192                 };
3193                 assert_eq!(tx_a, tx_b);
3194                 check_spends!(tx_a, funding_tx);
3195
3196                 (as_update, bs_update)
3197         }
3198
3199         struct SendEvent {
3200                 node_id: PublicKey,
3201                 msgs: Vec<msgs::UpdateAddHTLC>,
3202                 commitment_msg: msgs::CommitmentSigned,
3203         }
3204         impl SendEvent {
3205                 fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
3206                         assert!(updates.update_fulfill_htlcs.is_empty());
3207                         assert!(updates.update_fail_htlcs.is_empty());
3208                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3209                         assert!(updates.update_fee.is_none());
3210                         SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
3211                 }
3212
3213                 fn from_event(event: MessageSendEvent) -> SendEvent {
3214                         match event {
3215                                 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
3216                                 _ => panic!("Unexpected event type!"),
3217                         }
3218                 }
3219         }
3220
3221         macro_rules! check_added_monitors {
3222                 ($node: expr, $count: expr) => {
3223                         {
3224                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
3225                                 assert_eq!(added_monitors.len(), $count);
3226                                 added_monitors.clear();
3227                         }
3228                 }
3229         }
3230
3231         macro_rules! commitment_signed_dance {
3232                 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
3233                         {
3234                                 check_added_monitors!($node_a, 0);
3235                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3236                                 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
3237                                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
3238                                 check_added_monitors!($node_a, 1);
3239                                 check_added_monitors!($node_b, 0);
3240                                 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
3241                                 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3242                                 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
3243                                 check_added_monitors!($node_b, 1);
3244                                 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed).unwrap();
3245                                 let bs_revoke_and_ack = get_event_msg!($node_b, MessageSendEvent::SendRevokeAndACK, $node_a.node.get_our_node_id());
3246                                 check_added_monitors!($node_b, 1);
3247                                 if $fail_backwards {
3248                                         assert!($node_a.node.get_and_clear_pending_events().is_empty());
3249                                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3250                                 }
3251                                 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3252                                 if $fail_backwards {
3253                                         let channel_state = $node_a.node.channel_state.lock().unwrap();
3254                                         assert_eq!(channel_state.pending_msg_events.len(), 1);
3255                                         if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
3256                                                 assert_ne!(*node_id, $node_b.node.get_our_node_id());
3257                                         } else { panic!("Unexpected event"); }
3258                                 } else {
3259                                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3260                                 }
3261                                 {
3262                                         let mut added_monitors = $node_a.chan_monitor.added_monitors.lock().unwrap();
3263                                         if $fail_backwards {
3264                                                 assert_eq!(added_monitors.len(), 2);
3265                                                 assert!(added_monitors[0].0 != added_monitors[1].0);
3266                                         } else {
3267                                                 assert_eq!(added_monitors.len(), 1);
3268                                         }
3269                                         added_monitors.clear();
3270                                 }
3271                         }
3272                 }
3273         }
3274
3275         macro_rules! get_payment_preimage_hash {
3276                 ($node: expr) => {
3277                         {
3278                                 let payment_preimage = [*$node.network_payment_count.borrow(); 32];
3279                                 *$node.network_payment_count.borrow_mut() += 1;
3280                                 let mut payment_hash = [0; 32];
3281                                 let mut sha = Sha256::new();
3282                                 sha.input(&payment_preimage[..]);
3283                                 sha.result(&mut payment_hash);
3284                                 (payment_preimage, payment_hash)
3285                         }
3286                 }
3287         }
3288
3289         fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
3290                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
3291
3292                 let mut payment_event = {
3293                         origin_node.node.send_payment(route, our_payment_hash).unwrap();
3294                         check_added_monitors!(origin_node, 1);
3295
3296                         let mut events = origin_node.node.get_and_clear_pending_msg_events();
3297                         assert_eq!(events.len(), 1);
3298                         SendEvent::from_event(events.remove(0))
3299                 };
3300                 let mut prev_node = origin_node;
3301
3302                 for (idx, &node) in expected_route.iter().enumerate() {
3303                         assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
3304
3305                         node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3306                         check_added_monitors!(node, 0);
3307                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
3308
3309                         let events_1 = node.node.get_and_clear_pending_events();
3310                         assert_eq!(events_1.len(), 1);
3311                         match events_1[0] {
3312                                 Event::PendingHTLCsForwardable { .. } => { },
3313                                 _ => panic!("Unexpected event"),
3314                         };
3315
3316                         node.node.channel_state.lock().unwrap().next_forward = Instant::now();
3317                         node.node.process_pending_htlc_forwards();
3318
3319                         if idx == expected_route.len() - 1 {
3320                                 let events_2 = node.node.get_and_clear_pending_events();
3321                                 assert_eq!(events_2.len(), 1);
3322                                 match events_2[0] {
3323                                         Event::PaymentReceived { ref payment_hash, amt } => {
3324                                                 assert_eq!(our_payment_hash, *payment_hash);
3325                                                 assert_eq!(amt, recv_value);
3326                                         },
3327                                         _ => panic!("Unexpected event"),
3328                                 }
3329                         } else {
3330                                 let mut events_2 = node.node.get_and_clear_pending_msg_events();
3331                                 assert_eq!(events_2.len(), 1);
3332                                 check_added_monitors!(node, 1);
3333                                 payment_event = SendEvent::from_event(events_2.remove(0));
3334                                 assert_eq!(payment_event.msgs.len(), 1);
3335                         }
3336
3337                         prev_node = node;
3338                 }
3339
3340                 (our_payment_preimage, our_payment_hash)
3341         }
3342
3343         fn claim_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_preimage: [u8; 32]) {
3344                 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
3345                 check_added_monitors!(expected_route.last().unwrap(), 1);
3346
3347                 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
3348                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
3349                 macro_rules! get_next_msgs {
3350                         ($node: expr) => {
3351                                 {
3352                                         let events = $node.node.get_and_clear_pending_msg_events();
3353                                         assert_eq!(events.len(), 1);
3354                                         match events[0] {
3355                                                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
3356                                                         assert!(update_add_htlcs.is_empty());
3357                                                         assert_eq!(update_fulfill_htlcs.len(), 1);
3358                                                         assert!(update_fail_htlcs.is_empty());
3359                                                         assert!(update_fail_malformed_htlcs.is_empty());
3360                                                         assert!(update_fee.is_none());
3361                                                         expected_next_node = node_id.clone();
3362                                                         Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
3363                                                 },
3364                                                 _ => panic!("Unexpected event"),
3365                                         }
3366                                 }
3367                         }
3368                 }
3369
3370                 macro_rules! last_update_fulfill_dance {
3371                         ($node: expr, $prev_node: expr) => {
3372                                 {
3373                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3374                                         check_added_monitors!($node, 0);
3375                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
3376                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
3377                                 }
3378                         }
3379                 }
3380                 macro_rules! mid_update_fulfill_dance {
3381                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
3382                                 {
3383                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3384                                         check_added_monitors!($node, 1);
3385                                         let new_next_msgs = if $new_msgs {
3386                                                 get_next_msgs!($node)
3387                                         } else {
3388                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
3389                                                 None
3390                                         };
3391                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
3392                                         next_msgs = new_next_msgs;
3393                                 }
3394                         }
3395                 }
3396
3397                 let mut prev_node = expected_route.last().unwrap();
3398                 for (idx, node) in expected_route.iter().rev().enumerate() {
3399                         assert_eq!(expected_next_node, node.node.get_our_node_id());
3400                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
3401                         if next_msgs.is_some() {
3402                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
3403                         } else if update_next_msgs {
3404                                 next_msgs = get_next_msgs!(node);
3405                         } else {
3406                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
3407                         }
3408                         if !skip_last && idx == expected_route.len() - 1 {
3409                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
3410                         }
3411
3412                         prev_node = node;
3413                 }
3414
3415                 if !skip_last {
3416                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
3417                         let events = origin_node.node.get_and_clear_pending_events();
3418                         assert_eq!(events.len(), 1);
3419                         match events[0] {
3420                                 Event::PaymentSent { payment_preimage } => {
3421                                         assert_eq!(payment_preimage, our_payment_preimage);
3422                                 },
3423                                 _ => panic!("Unexpected event"),
3424                         }
3425                 }
3426         }
3427
3428         fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
3429                 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage);
3430         }
3431
3432         const TEST_FINAL_CLTV: u32 = 32;
3433
3434         fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
3435                 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();
3436                 assert_eq!(route.hops.len(), expected_route.len());
3437                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
3438                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
3439                 }
3440
3441                 send_along_route(origin_node, route, expected_route, recv_value)
3442         }
3443
3444         fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
3445                 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();
3446                 assert_eq!(route.hops.len(), expected_route.len());
3447                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
3448                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
3449                 }
3450
3451                 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
3452
3453                 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
3454                 match err {
3455                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
3456                         _ => panic!("Unknown error variants"),
3457                 };
3458         }
3459
3460         fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
3461                 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
3462                 claim_payment(&origin, expected_route, our_payment_preimage);
3463         }
3464
3465         fn fail_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_hash: [u8; 32]) {
3466                 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, PaymentFailReason::PreimageUnknown));
3467                 check_added_monitors!(expected_route.last().unwrap(), 1);
3468
3469                 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
3470                 macro_rules! update_fail_dance {
3471                         ($node: expr, $prev_node: expr, $last_node: expr) => {
3472                                 {
3473                                         $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
3474                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
3475                                 }
3476                         }
3477                 }
3478
3479                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
3480                 let mut prev_node = expected_route.last().unwrap();
3481                 for (idx, node) in expected_route.iter().rev().enumerate() {
3482                         assert_eq!(expected_next_node, node.node.get_our_node_id());
3483                         if next_msgs.is_some() {
3484                                 // We may be the "last node" for the purpose of the commitment dance if we're
3485                                 // skipping the last node (implying it is disconnected) and we're the
3486                                 // second-to-last node!
3487                                 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
3488                         }
3489
3490                         let events = node.node.get_and_clear_pending_msg_events();
3491                         if !skip_last || idx != expected_route.len() - 1 {
3492                                 assert_eq!(events.len(), 1);
3493                                 match events[0] {
3494                                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
3495                                                 assert!(update_add_htlcs.is_empty());
3496                                                 assert!(update_fulfill_htlcs.is_empty());
3497                                                 assert_eq!(update_fail_htlcs.len(), 1);
3498                                                 assert!(update_fail_malformed_htlcs.is_empty());
3499                                                 assert!(update_fee.is_none());
3500                                                 expected_next_node = node_id.clone();
3501                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
3502                                         },
3503                                         _ => panic!("Unexpected event"),
3504                                 }
3505                         } else {
3506                                 assert!(events.is_empty());
3507                         }
3508                         if !skip_last && idx == expected_route.len() - 1 {
3509                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
3510                         }
3511
3512                         prev_node = node;
3513                 }
3514
3515                 if !skip_last {
3516                         update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
3517
3518                         let events = origin_node.node.get_and_clear_pending_events();
3519                         assert_eq!(events.len(), 1);
3520                         match events[0] {
3521                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
3522                                         assert_eq!(payment_hash, our_payment_hash);
3523                                         assert!(rejected_by_dest);
3524                                 },
3525                                 _ => panic!("Unexpected event"),
3526                         }
3527                 }
3528         }
3529
3530         fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
3531                 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
3532         }
3533
3534         fn create_network(node_count: usize) -> Vec<Node> {
3535                 let mut nodes = Vec::new();
3536                 let mut rng = thread_rng();
3537                 let secp_ctx = Secp256k1::new();
3538                 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
3539
3540                 let chan_count = Rc::new(RefCell::new(0));
3541                 let payment_count = Rc::new(RefCell::new(0));
3542
3543                 for _ in 0..node_count {
3544                         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
3545                         let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
3546                         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
3547                         let mut seed = [0; 32];
3548                         rng.fill_bytes(&mut seed);
3549                         let keys_manager = Arc::new(keysinterface::KeysManager::new(&seed, Network::Testnet, Arc::clone(&logger)));
3550                         let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone()));
3551                         let node = ChannelManager::new(0, true, Network::Testnet, feeest.clone(), chan_monitor.clone(), chain_monitor.clone(), tx_broadcaster.clone(), Arc::clone(&logger), keys_manager.clone()).unwrap();
3552                         let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()), chain_monitor.clone(), Arc::clone(&logger));
3553                         nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router,
3554                                 network_payment_count: payment_count.clone(),
3555                                 network_chan_count: chan_count.clone(),
3556                         });
3557                 }
3558
3559                 nodes
3560         }
3561
3562         #[test]
3563         fn test_async_inbound_update_fee() {
3564                 let mut nodes = create_network(2);
3565                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3566                 let channel_id = chan.2;
3567
3568                 macro_rules! get_feerate {
3569                         ($node: expr) => {{
3570                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3571                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3572                                 chan.get_feerate()
3573                         }}
3574                 }
3575
3576                 // balancing
3577                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
3578
3579                 // A                                        B
3580                 // update_fee                            ->
3581                 // send (1) commitment_signed            -.
3582                 //                                       <- update_add_htlc/commitment_signed
3583                 // send (2) RAA (awaiting remote revoke) -.
3584                 // (1) commitment_signed is delivered    ->
3585                 //                                       .- send (3) RAA (awaiting remote revoke)
3586                 // (2) RAA is delivered                  ->
3587                 //                                       .- send (4) commitment_signed
3588                 //                                       <- (3) RAA is delivered
3589                 // send (5) commitment_signed            -.
3590                 //                                       <- (4) commitment_signed is delivered
3591                 // send (6) RAA                          -.
3592                 // (5) commitment_signed is delivered    ->
3593                 //                                       <- RAA
3594                 // (6) RAA is delivered                  ->
3595
3596                 // First nodes[0] generates an update_fee
3597                 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0]) + 20).unwrap();
3598                 check_added_monitors!(nodes[0], 1);
3599
3600                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
3601                 assert_eq!(events_0.len(), 1);
3602                 let (update_msg, commitment_signed) = match events_0[0] { // (1)
3603                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
3604                                 (update_fee.as_ref(), commitment_signed)
3605                         },
3606                         _ => panic!("Unexpected event"),
3607                 };
3608
3609                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3610
3611                 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
3612                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3613                 nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
3614                 check_added_monitors!(nodes[1], 1);
3615
3616                 let payment_event = {
3617                         let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
3618                         assert_eq!(events_1.len(), 1);
3619                         SendEvent::from_event(events_1.remove(0))
3620                 };
3621                 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
3622                 assert_eq!(payment_event.msgs.len(), 1);
3623
3624                 // ...now when the messages get delivered everyone should be happy
3625                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3626                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
3627                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3628                 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
3629                 check_added_monitors!(nodes[0], 1);
3630
3631                 // deliver(1), generate (3):
3632                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3633                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3634                 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
3635                 check_added_monitors!(nodes[1], 1);
3636
3637                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap(); // deliver (2)
3638                 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3639                 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
3640                 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
3641                 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
3642                 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
3643                 assert!(bs_update.update_fee.is_none()); // (4)
3644                 check_added_monitors!(nodes[1], 1);
3645
3646                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap(); // deliver (3)
3647                 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3648                 assert!(as_update.update_add_htlcs.is_empty()); // (5)
3649                 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
3650                 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
3651                 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
3652                 assert!(as_update.update_fee.is_none()); // (5)
3653                 check_added_monitors!(nodes[0], 1);
3654
3655                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed).unwrap(); // deliver (4)
3656                 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3657                 // only (6) so get_event_msg's assert(len == 1) passes
3658                 check_added_monitors!(nodes[0], 1);
3659
3660                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed).unwrap(); // deliver (5)
3661                 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3662                 check_added_monitors!(nodes[1], 1);
3663
3664                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
3665                 check_added_monitors!(nodes[0], 1);
3666
3667                 let events_2 = nodes[0].node.get_and_clear_pending_events();
3668                 assert_eq!(events_2.len(), 1);
3669                 match events_2[0] {
3670                         Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
3671                         _ => panic!("Unexpected event"),
3672                 }
3673
3674                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap(); // deliver (6)
3675                 check_added_monitors!(nodes[1], 1);
3676         }
3677
3678         #[test]
3679         fn test_update_fee_unordered_raa() {
3680                 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
3681                 // crash in an earlier version of the update_fee patch)
3682                 let mut nodes = create_network(2);
3683                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3684                 let channel_id = chan.2;
3685
3686                 macro_rules! get_feerate {
3687                         ($node: expr) => {{
3688                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3689                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3690                                 chan.get_feerate()
3691                         }}
3692                 }
3693
3694                 // balancing
3695                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
3696
3697                 // First nodes[0] generates an update_fee
3698                 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0]) + 20).unwrap();
3699                 check_added_monitors!(nodes[0], 1);
3700
3701                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
3702                 assert_eq!(events_0.len(), 1);
3703                 let update_msg = match events_0[0] { // (1)
3704                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
3705                                 update_fee.as_ref()
3706                         },
3707                         _ => panic!("Unexpected event"),
3708                 };
3709
3710                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3711
3712                 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
3713                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
3714                 nodes[1].node.send_payment(nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 40000, TEST_FINAL_CLTV).unwrap(), our_payment_hash).unwrap();
3715                 check_added_monitors!(nodes[1], 1);
3716
3717                 let payment_event = {
3718                         let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
3719                         assert_eq!(events_1.len(), 1);
3720                         SendEvent::from_event(events_1.remove(0))
3721                 };
3722                 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
3723                 assert_eq!(payment_event.msgs.len(), 1);
3724
3725                 // ...now when the messages get delivered everyone should be happy
3726                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
3727                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
3728                 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3729                 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
3730                 check_added_monitors!(nodes[0], 1);
3731
3732                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
3733                 check_added_monitors!(nodes[1], 1);
3734
3735                 // We can't continue, sadly, because our (1) now has a bogus signature
3736         }
3737
3738         #[test]
3739         fn test_multi_flight_update_fee() {
3740                 let nodes = create_network(2);
3741                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3742                 let channel_id = chan.2;
3743
3744                 macro_rules! get_feerate {
3745                         ($node: expr) => {{
3746                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3747                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3748                                 chan.get_feerate()
3749                         }}
3750                 }
3751
3752                 // A                                        B
3753                 // update_fee/commitment_signed          ->
3754                 //                                       .- send (1) RAA and (2) commitment_signed
3755                 // update_fee (never committed)          ->
3756                 // (3) update_fee                        ->
3757                 // We have to manually generate the above update_fee, it is allowed by the protocol but we
3758                 // don't track which updates correspond to which revoke_and_ack responses so we're in
3759                 // AwaitingRAA mode and will not generate the update_fee yet.
3760                 //                                       <- (1) RAA delivered
3761                 // (3) is generated and send (4) CS      -.
3762                 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
3763                 // know the per_commitment_point to use for it.
3764                 //                                       <- (2) commitment_signed delivered
3765                 // revoke_and_ack                        ->
3766                 //                                          B should send no response here
3767                 // (4) commitment_signed delivered       ->
3768                 //                                       <- RAA/commitment_signed delivered
3769                 // revoke_and_ack                        ->
3770
3771                 // First nodes[0] generates an update_fee
3772                 let initial_feerate = get_feerate!(nodes[0]);
3773                 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
3774                 check_added_monitors!(nodes[0], 1);
3775
3776                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
3777                 assert_eq!(events_0.len(), 1);
3778                 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
3779                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
3780                                 (update_fee.as_ref().unwrap(), commitment_signed)
3781                         },
3782                         _ => panic!("Unexpected event"),
3783                 };
3784
3785                 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
3786                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
3787                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
3788                 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3789                 check_added_monitors!(nodes[1], 1);
3790
3791                 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
3792                 // transaction:
3793                 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
3794                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3795                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3796
3797                 // Create the (3) update_fee message that nodes[0] will generate before it does...
3798                 let mut update_msg_2 = msgs::UpdateFee {
3799                         channel_id: update_msg_1.channel_id.clone(),
3800                         feerate_per_kw: (initial_feerate + 30) as u32,
3801                 };
3802
3803                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
3804
3805                 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
3806                 // Deliver (3)
3807                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
3808
3809                 // Deliver (1), generating (3) and (4)
3810                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
3811                 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3812                 check_added_monitors!(nodes[0], 1);
3813                 assert!(as_second_update.update_add_htlcs.is_empty());
3814                 assert!(as_second_update.update_fulfill_htlcs.is_empty());
3815                 assert!(as_second_update.update_fail_htlcs.is_empty());
3816                 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
3817                 // Check that the update_fee newly generated matches what we delivered:
3818                 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
3819                 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
3820
3821                 // Deliver (2) commitment_signed
3822                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
3823                 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3824                 check_added_monitors!(nodes[0], 1);
3825                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3826
3827                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap();
3828                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3829                 check_added_monitors!(nodes[1], 1);
3830
3831                 // Delever (4)
3832                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed).unwrap();
3833                 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3834                 check_added_monitors!(nodes[1], 1);
3835
3836                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
3837                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3838                 check_added_monitors!(nodes[0], 1);
3839
3840                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment).unwrap();
3841                 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3842                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3843                 check_added_monitors!(nodes[0], 1);
3844
3845                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap();
3846                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3847                 check_added_monitors!(nodes[1], 1);
3848         }
3849
3850         #[test]
3851         fn test_update_fee_vanilla() {
3852                 let nodes = create_network(2);
3853                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3854                 let channel_id = chan.2;
3855
3856                 macro_rules! get_feerate {
3857                         ($node: expr) => {{
3858                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3859                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3860                                 chan.get_feerate()
3861                         }}
3862                 }
3863
3864                 let feerate = get_feerate!(nodes[0]);
3865                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
3866                 check_added_monitors!(nodes[0], 1);
3867
3868                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
3869                 assert_eq!(events_0.len(), 1);
3870                 let (update_msg, commitment_signed) = match events_0[0] {
3871                                 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
3872                                 (update_fee.as_ref(), commitment_signed)
3873                         },
3874                         _ => panic!("Unexpected event"),
3875                 };
3876                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3877
3878                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3879                 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3880                 check_added_monitors!(nodes[1], 1);
3881
3882                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
3883                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3884                 check_added_monitors!(nodes[0], 1);
3885
3886                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
3887                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3888                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3889                 check_added_monitors!(nodes[0], 1);
3890
3891                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
3892                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3893                 check_added_monitors!(nodes[1], 1);
3894         }
3895
3896         #[test]
3897         fn test_update_fee_with_fundee_update_add_htlc() {
3898                 let mut nodes = create_network(2);
3899                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
3900                 let channel_id = chan.2;
3901
3902                 macro_rules! get_feerate {
3903                         ($node: expr) => {{
3904                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3905                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
3906                                 chan.get_feerate()
3907                         }}
3908                 }
3909
3910                 // balancing
3911                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
3912
3913                 let feerate = get_feerate!(nodes[0]);
3914                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
3915                 check_added_monitors!(nodes[0], 1);
3916
3917                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
3918                 assert_eq!(events_0.len(), 1);
3919                 let (update_msg, commitment_signed) = match events_0[0] {
3920                                 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
3921                                 (update_fee.as_ref(), commitment_signed)
3922                         },
3923                         _ => panic!("Unexpected event"),
3924                 };
3925                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
3926                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
3927                 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3928                 check_added_monitors!(nodes[1], 1);
3929
3930                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
3931
3932                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
3933
3934                 // nothing happens since node[1] is in AwaitingRemoteRevoke
3935                 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
3936                 {
3937                         let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
3938                         assert_eq!(added_monitors.len(), 0);
3939                         added_monitors.clear();
3940                 }
3941                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
3942                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3943                 // node[1] has nothing to do
3944
3945                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
3946                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3947                 check_added_monitors!(nodes[0], 1);
3948
3949                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
3950                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
3951                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3952                 check_added_monitors!(nodes[0], 1);
3953                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
3954                 check_added_monitors!(nodes[1], 1);
3955                 // AwaitingRemoteRevoke ends here
3956
3957                 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
3958                 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
3959                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
3960                 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
3961                 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
3962                 assert_eq!(commitment_update.update_fee.is_none(), true);
3963
3964                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
3965                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
3966                 check_added_monitors!(nodes[0], 1);
3967                 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
3968
3969                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
3970                 check_added_monitors!(nodes[1], 1);
3971                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
3972
3973                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
3974                 check_added_monitors!(nodes[1], 1);
3975                 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
3976                 // No commitment_signed so get_event_msg's assert(len == 1) passes
3977
3978                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
3979                 check_added_monitors!(nodes[0], 1);
3980                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
3981
3982                 let events = nodes[0].node.get_and_clear_pending_events();
3983                 assert_eq!(events.len(), 1);
3984                 match events[0] {
3985                         Event::PendingHTLCsForwardable { .. } => { },
3986                         _ => panic!("Unexpected event"),
3987                 };
3988                 nodes[0].node.channel_state.lock().unwrap().next_forward = Instant::now();
3989                 nodes[0].node.process_pending_htlc_forwards();
3990
3991                 let events = nodes[0].node.get_and_clear_pending_events();
3992                 assert_eq!(events.len(), 1);
3993                 match events[0] {
3994                         Event::PaymentReceived { .. } => { },
3995                         _ => panic!("Unexpected event"),
3996                 };
3997
3998                 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
3999
4000                 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
4001                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
4002                 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
4003         }
4004
4005         #[test]
4006         fn test_update_fee() {
4007                 let nodes = create_network(2);
4008                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4009                 let channel_id = chan.2;
4010
4011                 macro_rules! get_feerate {
4012                         ($node: expr) => {{
4013                                 let chan_lock = $node.node.channel_state.lock().unwrap();
4014                                 let chan = chan_lock.by_id.get(&channel_id).unwrap();
4015                                 chan.get_feerate()
4016                         }}
4017                 }
4018
4019                 // A                                        B
4020                 // (1) update_fee/commitment_signed      ->
4021                 //                                       <- (2) revoke_and_ack
4022                 //                                       .- send (3) commitment_signed
4023                 // (4) update_fee/commitment_signed      ->
4024                 //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
4025                 //                                       <- (3) commitment_signed delivered
4026                 // send (6) revoke_and_ack               -.
4027                 //                                       <- (5) deliver revoke_and_ack
4028                 // (6) deliver revoke_and_ack            ->
4029                 //                                       .- send (7) commitment_signed in response to (4)
4030                 //                                       <- (7) deliver commitment_signed
4031                 // revoke_and_ack                        ->
4032
4033                 // Create and deliver (1)...
4034                 let feerate = get_feerate!(nodes[0]);
4035                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
4036                 check_added_monitors!(nodes[0], 1);
4037
4038                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4039                 assert_eq!(events_0.len(), 1);
4040                 let (update_msg, commitment_signed) = match events_0[0] {
4041                                 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
4042                                 (update_fee.as_ref(), commitment_signed)
4043                         },
4044                         _ => panic!("Unexpected event"),
4045                 };
4046                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4047
4048                 // Generate (2) and (3):
4049                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4050                 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4051                 check_added_monitors!(nodes[1], 1);
4052
4053                 // Deliver (2):
4054                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4055                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4056                 check_added_monitors!(nodes[0], 1);
4057
4058                 // Create and deliver (4)...
4059                 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
4060                 check_added_monitors!(nodes[0], 1);
4061                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4062                 assert_eq!(events_0.len(), 1);
4063                 let (update_msg, commitment_signed) = match events_0[0] {
4064                                 MessageSendEvent::UpdateHTLCs { node_id:_, updates: msgs::CommitmentUpdate { update_add_htlcs:_, update_fulfill_htlcs:_, update_fail_htlcs:_, update_fail_malformed_htlcs:_, ref update_fee, ref commitment_signed } } => {
4065                                 (update_fee.as_ref(), commitment_signed)
4066                         },
4067                         _ => panic!("Unexpected event"),
4068                 };
4069
4070                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4071                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4072                 check_added_monitors!(nodes[1], 1);
4073                 // ... creating (5)
4074                 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4075                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4076
4077                 // Handle (3), creating (6):
4078                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
4079                 check_added_monitors!(nodes[0], 1);
4080                 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4081                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4082
4083                 // Deliver (5):
4084                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4085                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4086                 check_added_monitors!(nodes[0], 1);
4087
4088                 // Deliver (6), creating (7):
4089                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
4090                 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4091                 assert!(commitment_update.update_add_htlcs.is_empty());
4092                 assert!(commitment_update.update_fulfill_htlcs.is_empty());
4093                 assert!(commitment_update.update_fail_htlcs.is_empty());
4094                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
4095                 assert!(commitment_update.update_fee.is_none());
4096                 check_added_monitors!(nodes[1], 1);
4097
4098                 // Deliver (7)
4099                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4100                 check_added_monitors!(nodes[0], 1);
4101                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4102                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4103
4104                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4105                 check_added_monitors!(nodes[1], 1);
4106                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4107
4108                 assert_eq!(get_feerate!(nodes[0]), feerate + 30);
4109                 assert_eq!(get_feerate!(nodes[1]), feerate + 30);
4110                 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
4111         }
4112
4113         #[test]
4114         fn fake_network_test() {
4115                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
4116                 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
4117                 let nodes = create_network(4);
4118
4119                 // Create some initial channels
4120                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4121                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4122                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
4123
4124                 // Rebalance the network a bit by relaying one payment through all the channels...
4125                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
4126                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
4127                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
4128                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
4129
4130                 // Send some more payments
4131                 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
4132                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
4133                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
4134
4135                 // Test failure packets
4136                 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
4137                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
4138
4139                 // Add a new channel that skips 3
4140                 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
4141
4142                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
4143                 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
4144                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
4145                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
4146                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
4147                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
4148                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
4149
4150                 // Do some rebalance loop payments, simultaneously
4151                 let mut hops = Vec::with_capacity(3);
4152                 hops.push(RouteHop {
4153                         pubkey: nodes[2].node.get_our_node_id(),
4154                         short_channel_id: chan_2.0.contents.short_channel_id,
4155                         fee_msat: 0,
4156                         cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
4157                 });
4158                 hops.push(RouteHop {
4159                         pubkey: nodes[3].node.get_our_node_id(),
4160                         short_channel_id: chan_3.0.contents.short_channel_id,
4161                         fee_msat: 0,
4162                         cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
4163                 });
4164                 hops.push(RouteHop {
4165                         pubkey: nodes[1].node.get_our_node_id(),
4166                         short_channel_id: chan_4.0.contents.short_channel_id,
4167                         fee_msat: 1000000,
4168                         cltv_expiry_delta: TEST_FINAL_CLTV,
4169                 });
4170                 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;
4171                 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;
4172                 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
4173
4174                 let mut hops = Vec::with_capacity(3);
4175                 hops.push(RouteHop {
4176                         pubkey: nodes[3].node.get_our_node_id(),
4177                         short_channel_id: chan_4.0.contents.short_channel_id,
4178                         fee_msat: 0,
4179                         cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
4180                 });
4181                 hops.push(RouteHop {
4182                         pubkey: nodes[2].node.get_our_node_id(),
4183                         short_channel_id: chan_3.0.contents.short_channel_id,
4184                         fee_msat: 0,
4185                         cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
4186                 });
4187                 hops.push(RouteHop {
4188                         pubkey: nodes[1].node.get_our_node_id(),
4189                         short_channel_id: chan_2.0.contents.short_channel_id,
4190                         fee_msat: 1000000,
4191                         cltv_expiry_delta: TEST_FINAL_CLTV,
4192                 });
4193                 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;
4194                 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;
4195                 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
4196
4197                 // Claim the rebalances...
4198                 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
4199                 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
4200
4201                 // Add a duplicate new channel from 2 to 4
4202                 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
4203
4204                 // Send some payments across both channels
4205                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
4206                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
4207                 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
4208
4209                 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
4210
4211                 //TODO: Test that routes work again here as we've been notified that the channel is full
4212
4213                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
4214                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
4215                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
4216
4217                 // Close down the channels...
4218                 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
4219                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
4220                 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
4221                 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
4222                 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
4223         }
4224
4225         #[test]
4226         fn duplicate_htlc_test() {
4227                 // Test that we accept duplicate payment_hash HTLCs across the network and that
4228                 // claiming/failing them are all separate and don't effect each other
4229                 let mut nodes = create_network(6);
4230
4231                 // Create some initial channels to route via 3 to 4/5 from 0/1/2
4232                 create_announced_chan_between_nodes(&nodes, 0, 3);
4233                 create_announced_chan_between_nodes(&nodes, 1, 3);
4234                 create_announced_chan_between_nodes(&nodes, 2, 3);
4235                 create_announced_chan_between_nodes(&nodes, 3, 4);
4236                 create_announced_chan_between_nodes(&nodes, 3, 5);
4237
4238                 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
4239
4240                 *nodes[0].network_payment_count.borrow_mut() -= 1;
4241                 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
4242
4243                 *nodes[0].network_payment_count.borrow_mut() -= 1;
4244                 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
4245
4246                 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
4247                 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
4248                 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
4249         }
4250
4251         #[derive(PartialEq)]
4252         enum HTLCType { NONE, TIMEOUT, SUCCESS }
4253         /// Tests that the given node has broadcast transactions for the given Channel
4254         ///
4255         /// First checks that the latest local commitment tx has been broadcast, unless an explicit
4256         /// commitment_tx is provided, which may be used to test that a remote commitment tx was
4257         /// broadcast and the revoked outputs were claimed.
4258         ///
4259         /// Next tests that there is (or is not) a transaction that spends the commitment transaction
4260         /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
4261         ///
4262         /// All broadcast transactions must be accounted for in one of the above three types of we'll
4263         /// also fail.
4264         fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
4265                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
4266                 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
4267
4268                 let mut res = Vec::with_capacity(2);
4269                 node_txn.retain(|tx| {
4270                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
4271                                 check_spends!(tx, chan.3.clone());
4272                                 if commitment_tx.is_none() {
4273                                         res.push(tx.clone());
4274                                 }
4275                                 false
4276                         } else { true }
4277                 });
4278                 if let Some(explicit_tx) = commitment_tx {
4279                         res.push(explicit_tx.clone());
4280                 }
4281
4282                 assert_eq!(res.len(), 1);
4283
4284                 if has_htlc_tx != HTLCType::NONE {
4285                         node_txn.retain(|tx| {
4286                                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
4287                                         check_spends!(tx, res[0].clone());
4288                                         if has_htlc_tx == HTLCType::TIMEOUT {
4289                                                 assert!(tx.lock_time != 0);
4290                                         } else {
4291                                                 assert!(tx.lock_time == 0);
4292                                         }
4293                                         res.push(tx.clone());
4294                                         false
4295                                 } else { true }
4296                         });
4297                         assert_eq!(res.len(), 2);
4298                 }
4299
4300                 assert!(node_txn.is_empty());
4301                 res
4302         }
4303
4304         /// Tests that the given node has broadcast a claim transaction against the provided revoked
4305         /// HTLC transaction.
4306         fn test_revoked_htlc_claim_txn_broadcast(node: &Node, revoked_tx: Transaction) {
4307                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
4308                 assert_eq!(node_txn.len(), 1);
4309                 node_txn.retain(|tx| {
4310                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
4311                                 check_spends!(tx, revoked_tx.clone());
4312                                 false
4313                         } else { true }
4314                 });
4315                 assert!(node_txn.is_empty());
4316         }
4317
4318         fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
4319                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
4320
4321                 assert!(node_txn.len() >= 1);
4322                 assert_eq!(node_txn[0].input.len(), 1);
4323                 let mut found_prev = false;
4324
4325                 for tx in prev_txn {
4326                         if node_txn[0].input[0].previous_output.txid == tx.txid() {
4327                                 check_spends!(node_txn[0], tx.clone());
4328                                 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
4329                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
4330
4331                                 found_prev = true;
4332                                 break;
4333                         }
4334                 }
4335                 assert!(found_prev);
4336
4337                 let mut res = Vec::new();
4338                 mem::swap(&mut *node_txn, &mut res);
4339                 res
4340         }
4341
4342         fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
4343                 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
4344                 assert_eq!(events_1.len(), 1);
4345                 let as_update = match events_1[0] {
4346                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
4347                                 msg.clone()
4348                         },
4349                         _ => panic!("Unexpected event"),
4350                 };
4351
4352                 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
4353                 assert_eq!(events_2.len(), 1);
4354                 let bs_update = match events_2[0] {
4355                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
4356                                 msg.clone()
4357                         },
4358                         _ => panic!("Unexpected event"),
4359                 };
4360
4361                 for node in nodes {
4362                         node.router.handle_channel_update(&as_update).unwrap();
4363                         node.router.handle_channel_update(&bs_update).unwrap();
4364                 }
4365         }
4366
4367         macro_rules! expect_pending_htlcs_forwardable {
4368                 ($node: expr) => {{
4369                         let events = $node.node.get_and_clear_pending_events();
4370                         assert_eq!(events.len(), 1);
4371                         match events[0] {
4372                                 Event::PendingHTLCsForwardable { .. } => { },
4373                                 _ => panic!("Unexpected event"),
4374                         };
4375                         $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
4376                         $node.node.process_pending_htlc_forwards();
4377                 }}
4378         }
4379
4380         #[test]
4381         fn channel_reserve_test() {
4382                 use util::rng;
4383                 use std::sync::atomic::Ordering;
4384                 use ln::msgs::HandleError;
4385
4386                 macro_rules! get_channel_value_stat {
4387                         ($node: expr, $channel_id: expr) => {{
4388                                 let chan_lock = $node.node.channel_state.lock().unwrap();
4389                                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
4390                                 chan.get_value_stat()
4391                         }}
4392                 }
4393
4394                 let mut nodes = create_network(3);
4395                 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001);
4396                 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001);
4397
4398                 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
4399                 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
4400
4401                 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
4402                 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
4403
4404                 macro_rules! get_route_and_payment_hash {
4405                         ($recv_value: expr) => {{
4406                                 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
4407                                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4408                                 (route, payment_hash, payment_preimage)
4409                         }}
4410                 };
4411
4412                 macro_rules! expect_forward {
4413                         ($node: expr) => {{
4414                                 let mut events = $node.node.get_and_clear_pending_msg_events();
4415                                 assert_eq!(events.len(), 1);
4416                                 check_added_monitors!($node, 1);
4417                                 let payment_event = SendEvent::from_event(events.remove(0));
4418                                 payment_event
4419                         }}
4420                 }
4421
4422                 macro_rules! expect_payment_received {
4423                         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
4424                                 let events = $node.node.get_and_clear_pending_events();
4425                                 assert_eq!(events.len(), 1);
4426                                 match events[0] {
4427                                         Event::PaymentReceived { ref payment_hash, amt } => {
4428                                                 assert_eq!($expected_payment_hash, *payment_hash);
4429                                                 assert_eq!($expected_recv_value, amt);
4430                                         },
4431                                         _ => panic!("Unexpected event"),
4432                                 }
4433                         }
4434                 };
4435
4436                 let feemsat = 239; // somehow we know?
4437                 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
4438
4439                 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
4440
4441                 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
4442                 {
4443                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
4444                         assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
4445                         let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
4446                         match err {
4447                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
4448                                 _ => panic!("Unknown error variants"),
4449                         }
4450                 }
4451
4452                 let mut htlc_id = 0;
4453                 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
4454                 // nodes[0]'s wealth
4455                 loop {
4456                         let amt_msat = recv_value_0 + total_fee_msat;
4457                         if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
4458                                 break;
4459                         }
4460                         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
4461                         htlc_id += 1;
4462
4463                         let (stat01_, stat11_, stat12_, stat22_) = (
4464                                 get_channel_value_stat!(nodes[0], chan_1.2),
4465                                 get_channel_value_stat!(nodes[1], chan_1.2),
4466                                 get_channel_value_stat!(nodes[1], chan_2.2),
4467                                 get_channel_value_stat!(nodes[2], chan_2.2),
4468                         );
4469
4470                         assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
4471                         assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
4472                         assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
4473                         assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
4474                         stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
4475                 }
4476
4477                 {
4478                         let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
4479                         // attempt to get channel_reserve violation
4480                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
4481                         let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
4482                         match err {
4483                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
4484                                 _ => panic!("Unknown error variants"),
4485                         }
4486                 }
4487
4488                 // adding pending output
4489                 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
4490                 let amt_msat_1 = recv_value_1 + total_fee_msat;
4491
4492                 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
4493                 let payment_event_1 = {
4494                         nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
4495                         check_added_monitors!(nodes[0], 1);
4496
4497                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
4498                         assert_eq!(events.len(), 1);
4499                         SendEvent::from_event(events.remove(0))
4500                 };
4501                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
4502
4503                 // channel reserve test with htlc pending output > 0
4504                 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
4505                 {
4506                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
4507                         match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
4508                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
4509                                 _ => panic!("Unknown error variants"),
4510                         }
4511                 }
4512
4513                 {
4514                         // test channel_reserve test on nodes[1] side
4515                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
4516
4517                         // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
4518                         let secp_ctx = Secp256k1::new();
4519                         let session_priv = SecretKey::from_slice(&secp_ctx, &{
4520                                 let mut session_key = [0; 32];
4521                                 rng::fill_bytes(&mut session_key);
4522                                 session_key
4523                         }).expect("RNG is bad!");
4524
4525                         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
4526                         let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
4527                         let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height).unwrap();
4528                         let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
4529                         let msg = msgs::UpdateAddHTLC {
4530                                 channel_id: chan_1.2,
4531                                 htlc_id,
4532                                 amount_msat: htlc_msat,
4533                                 payment_hash: our_payment_hash,
4534                                 cltv_expiry: htlc_cltv,
4535                                 onion_routing_packet: onion_packet,
4536                         };
4537
4538                         let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
4539                         match err {
4540                                 HandleError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
4541                         }
4542                 }
4543
4544                 // split the rest to test holding cell
4545                 let recv_value_21 = recv_value_2/2;
4546                 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
4547                 {
4548                         let stat = get_channel_value_stat!(nodes[0], chan_1.2);
4549                         assert_eq!(stat.value_to_self_msat - (stat.pending_outbound_htlcs_amount_msat + recv_value_21 + recv_value_22 + total_fee_msat + total_fee_msat), stat.channel_reserve_msat);
4550                 }
4551
4552                 // now see if they go through on both sides
4553                 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
4554                 // but this will stuck in the holding cell
4555                 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
4556                 check_added_monitors!(nodes[0], 0);
4557                 let events = nodes[0].node.get_and_clear_pending_events();
4558                 assert_eq!(events.len(), 0);
4559
4560                 // test with outbound holding cell amount > 0
4561                 {
4562                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
4563                         match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
4564                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
4565                                 _ => panic!("Unknown error variants"),
4566                         }
4567                 }
4568
4569                 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
4570                 // this will also stuck in the holding cell
4571                 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
4572                 check_added_monitors!(nodes[0], 0);
4573                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4574                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4575
4576                 // flush the pending htlc
4577                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
4578                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4579                 check_added_monitors!(nodes[1], 1);
4580
4581                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
4582                 check_added_monitors!(nodes[0], 1);
4583                 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4584
4585                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed).unwrap();
4586                 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4587                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4588                 check_added_monitors!(nodes[0], 1);
4589
4590                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
4591                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4592                 check_added_monitors!(nodes[1], 1);
4593
4594                 expect_pending_htlcs_forwardable!(nodes[1]);
4595
4596                 let ref payment_event_11 = expect_forward!(nodes[1]);
4597                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
4598                 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
4599
4600                 expect_pending_htlcs_forwardable!(nodes[2]);
4601                 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
4602
4603                 // flush the htlcs in the holding cell
4604                 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
4605                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
4606                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
4607                 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
4608                 expect_pending_htlcs_forwardable!(nodes[1]);
4609
4610                 let ref payment_event_3 = expect_forward!(nodes[1]);
4611                 assert_eq!(payment_event_3.msgs.len(), 2);
4612                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
4613                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
4614
4615                 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
4616                 expect_pending_htlcs_forwardable!(nodes[2]);
4617
4618                 let events = nodes[2].node.get_and_clear_pending_events();
4619                 assert_eq!(events.len(), 2);
4620                 match events[0] {
4621                         Event::PaymentReceived { ref payment_hash, amt } => {
4622                                 assert_eq!(our_payment_hash_21, *payment_hash);
4623                                 assert_eq!(recv_value_21, amt);
4624                         },
4625                         _ => panic!("Unexpected event"),
4626                 }
4627                 match events[1] {
4628                         Event::PaymentReceived { ref payment_hash, amt } => {
4629                                 assert_eq!(our_payment_hash_22, *payment_hash);
4630                                 assert_eq!(recv_value_22, amt);
4631                         },
4632                         _ => panic!("Unexpected event"),
4633                 }
4634
4635                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
4636                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
4637                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
4638
4639                 let expected_value_to_self = stat01.value_to_self_msat - (recv_value_1 + total_fee_msat) - (recv_value_21 + total_fee_msat) - (recv_value_22 + total_fee_msat);
4640                 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
4641                 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
4642                 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
4643
4644                 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
4645                 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
4646         }
4647
4648         #[test]
4649         fn channel_monitor_network_test() {
4650                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
4651                 // tests that ChannelMonitor is able to recover from various states.
4652                 let nodes = create_network(5);
4653
4654                 // Create some initial channels
4655                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4656                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4657                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
4658                 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
4659
4660                 // Rebalance the network a bit by relaying one payment through all the channels...
4661                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
4662                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
4663                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
4664                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
4665
4666                 // Simple case with no pending HTLCs:
4667                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
4668                 {
4669                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
4670                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4671                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
4672                         test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
4673                 }
4674                 get_announce_close_broadcast_events(&nodes, 0, 1);
4675                 assert_eq!(nodes[0].node.list_channels().len(), 0);
4676                 assert_eq!(nodes[1].node.list_channels().len(), 1);
4677
4678                 // One pending HTLC is discarded by the force-close:
4679                 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
4680
4681                 // Simple case of one pending HTLC to HTLC-Timeout
4682                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
4683                 {
4684                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
4685                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4686                         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
4687                         test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
4688                 }
4689                 get_announce_close_broadcast_events(&nodes, 1, 2);
4690                 assert_eq!(nodes[1].node.list_channels().len(), 0);
4691                 assert_eq!(nodes[2].node.list_channels().len(), 1);
4692
4693                 macro_rules! claim_funds {
4694                         ($node: expr, $prev_node: expr, $preimage: expr) => {
4695                                 {
4696                                         assert!($node.node.claim_funds($preimage));
4697                                         check_added_monitors!($node, 1);
4698
4699                                         let events = $node.node.get_and_clear_pending_msg_events();
4700                                         assert_eq!(events.len(), 1);
4701                                         match events[0] {
4702                                                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
4703                                                         assert!(update_add_htlcs.is_empty());
4704                                                         assert!(update_fail_htlcs.is_empty());
4705                                                         assert_eq!(*node_id, $prev_node.node.get_our_node_id());
4706                                                 },
4707                                                 _ => panic!("Unexpected event"),
4708                                         };
4709                                 }
4710                         }
4711                 }
4712
4713                 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
4714                 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
4715                 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
4716                 {
4717                         let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
4718
4719                         // Claim the payment on nodes[3], giving it knowledge of the preimage
4720                         claim_funds!(nodes[3], nodes[2], payment_preimage_1);
4721
4722                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4723                         nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
4724
4725                         check_preimage_claim(&nodes[3], &node_txn);
4726                 }
4727                 get_announce_close_broadcast_events(&nodes, 2, 3);
4728                 assert_eq!(nodes[2].node.list_channels().len(), 0);
4729                 assert_eq!(nodes[3].node.list_channels().len(), 1);
4730
4731                 { // Cheat and reset nodes[4]'s height to 1
4732                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4733                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![] }, 1);
4734                 }
4735
4736                 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
4737                 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
4738                 // One pending HTLC to time out:
4739                 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
4740                 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
4741                 // buffer space).
4742
4743                 {
4744                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4745                         nodes[3].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
4746                         for i in 3..TEST_FINAL_CLTV + 2 + HTLC_FAIL_TIMEOUT_BLOCKS + 1 {
4747                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4748                                 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
4749                         }
4750
4751                         let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
4752
4753                         // Claim the payment on nodes[4], giving it knowledge of the preimage
4754                         claim_funds!(nodes[4], nodes[3], payment_preimage_2);
4755
4756                         header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4757                         nodes[4].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
4758                         for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
4759                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4760                                 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
4761                         }
4762
4763                         test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
4764
4765                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4766                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
4767
4768                         check_preimage_claim(&nodes[4], &node_txn);
4769                 }
4770                 get_announce_close_broadcast_events(&nodes, 3, 4);
4771                 assert_eq!(nodes[3].node.list_channels().len(), 0);
4772                 assert_eq!(nodes[4].node.list_channels().len(), 0);
4773
4774                 // Create some new channels:
4775                 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
4776
4777                 // A pending HTLC which will be revoked:
4778                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4779                 // Get the will-be-revoked local txn from nodes[0]
4780                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
4781                 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
4782                 assert_eq!(revoked_local_txn[0].input.len(), 1);
4783                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
4784                 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
4785                 assert_eq!(revoked_local_txn[1].input.len(), 1);
4786                 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
4787                 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
4788                 // Revoke the old state
4789                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
4790
4791                 {
4792                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4793                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4794                         {
4795                                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4796                                 assert_eq!(node_txn.len(), 3);
4797                                 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
4798                                 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
4799
4800                                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
4801                                 node_txn.swap_remove(0);
4802                         }
4803                         test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
4804
4805                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4806                         let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
4807                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4808                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
4809                         test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
4810                 }
4811                 get_announce_close_broadcast_events(&nodes, 0, 1);
4812                 assert_eq!(nodes[0].node.list_channels().len(), 0);
4813                 assert_eq!(nodes[1].node.list_channels().len(), 0);
4814         }
4815
4816         #[test]
4817         fn revoked_output_claim() {
4818                 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
4819                 // transaction is broadcast by its counterparty
4820                 let nodes = create_network(2);
4821                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4822                 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
4823                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4824                 assert_eq!(revoked_local_txn.len(), 1);
4825                 // Only output is the full channel value back to nodes[0]:
4826                 assert_eq!(revoked_local_txn[0].output.len(), 1);
4827                 // Send a payment through, updating everyone's latest commitment txn
4828                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
4829
4830                 // Inform nodes[1] that nodes[0] broadcast a stale tx
4831                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4832                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4833                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4834                 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
4835
4836                 assert_eq!(node_txn[0], node_txn[2]);
4837
4838                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
4839                 check_spends!(node_txn[1], chan_1.3.clone());
4840
4841                 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
4842                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4843                 get_announce_close_broadcast_events(&nodes, 0, 1);
4844         }
4845
4846         #[test]
4847         fn claim_htlc_outputs_shared_tx() {
4848                 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
4849                 let nodes = create_network(2);
4850
4851                 // Create some new channel:
4852                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4853
4854                 // Rebalance the network to generate htlc in the two directions
4855                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4856                 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx
4857                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4858                 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
4859
4860                 // Get the will-be-revoked local txn from node[0]
4861                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4862                 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
4863                 assert_eq!(revoked_local_txn[0].input.len(), 1);
4864                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
4865                 assert_eq!(revoked_local_txn[1].input.len(), 1);
4866                 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
4867                 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
4868                 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
4869
4870                 //Revoke the old state
4871                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
4872
4873                 {
4874                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4875
4876                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4877
4878                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
4879                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4880                         assert_eq!(node_txn.len(), 4);
4881
4882                         assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
4883                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
4884
4885                         assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
4886
4887                         let mut witness_lens = BTreeSet::new();
4888                         witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
4889                         witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
4890                         witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
4891                         assert_eq!(witness_lens.len(), 3);
4892                         assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
4893                         assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
4894                         assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
4895
4896                         // Next nodes[1] broadcasts its current local tx state:
4897                         assert_eq!(node_txn[1].input.len(), 1);
4898                         assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
4899
4900                         assert_eq!(node_txn[2].input.len(), 1);
4901                         let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
4902                         assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
4903                         assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
4904                         assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
4905                         assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
4906                 }
4907                 get_announce_close_broadcast_events(&nodes, 0, 1);
4908                 assert_eq!(nodes[0].node.list_channels().len(), 0);
4909                 assert_eq!(nodes[1].node.list_channels().len(), 0);
4910         }
4911
4912         #[test]
4913         fn claim_htlc_outputs_single_tx() {
4914                 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
4915                 let nodes = create_network(2);
4916
4917                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4918
4919                 // Rebalance the network to generate htlc in the two directions
4920                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4921                 // node[0] is gonna to revoke an old state thus node[1] should be able to claim both offered/received HTLC outputs on top of commitment tx, but this
4922                 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
4923                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
4924                 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
4925
4926                 // Get the will-be-revoked local txn from node[0]
4927                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
4928
4929                 //Revoke the old state
4930                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
4931
4932                 {
4933                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4934
4935                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
4936
4937                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
4938                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
4939                         assert_eq!(node_txn.len(), 12); // ChannelManager : 2, ChannelMontitor: 8 (1 standard revoked output, 2 revocation htlc tx, 1 local commitment tx + 1 htlc timeout tx) * 2 (block-rescan)
4940
4941                         assert_eq!(node_txn[0], node_txn[7]);
4942                         assert_eq!(node_txn[1], node_txn[8]);
4943                         assert_eq!(node_txn[2], node_txn[9]);
4944                         assert_eq!(node_txn[3], node_txn[10]);
4945                         assert_eq!(node_txn[4], node_txn[11]);
4946                         assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcated by ChannelManger
4947                         assert_eq!(node_txn[4], node_txn[6]);
4948
4949                         assert_eq!(node_txn[0].input.len(), 1);
4950                         assert_eq!(node_txn[1].input.len(), 1);
4951                         assert_eq!(node_txn[2].input.len(), 1);
4952
4953                         let mut revoked_tx_map = HashMap::new();
4954                         revoked_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
4955                         node_txn[0].verify(&revoked_tx_map).unwrap();
4956                         node_txn[1].verify(&revoked_tx_map).unwrap();
4957                         node_txn[2].verify(&revoked_tx_map).unwrap();
4958
4959                         let mut witness_lens = BTreeSet::new();
4960                         witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
4961                         witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
4962                         witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
4963                         assert_eq!(witness_lens.len(), 3);
4964                         assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
4965                         assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
4966                         assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
4967
4968                         assert_eq!(node_txn[3].input.len(), 1);
4969                         check_spends!(node_txn[3], chan_1.3.clone());
4970
4971                         assert_eq!(node_txn[4].input.len(), 1);
4972                         let witness_script = node_txn[4].input[0].witness.last().unwrap();
4973                         assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
4974                         assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
4975                         assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
4976                         assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
4977                 }
4978                 get_announce_close_broadcast_events(&nodes, 0, 1);
4979                 assert_eq!(nodes[0].node.list_channels().len(), 0);
4980                 assert_eq!(nodes[1].node.list_channels().len(), 0);
4981         }
4982
4983         #[test]
4984         fn test_htlc_ignore_latest_remote_commitment() {
4985                 // Test that HTLC transactions spending the latest remote commitment transaction are simply
4986                 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
4987                 let nodes = create_network(2);
4988                 create_announced_chan_between_nodes(&nodes, 0, 1);
4989
4990                 route_payment(&nodes[0], &[&nodes[1]], 10000000);
4991                 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
4992                 {
4993                         let events = nodes[0].node.get_and_clear_pending_msg_events();
4994                         assert_eq!(events.len(), 1);
4995                         match events[0] {
4996                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
4997                                         assert_eq!(flags & 0b10, 0b10);
4998                                 },
4999                                 _ => panic!("Unexpected event"),
5000                         }
5001                 }
5002
5003                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5004                 assert_eq!(node_txn.len(), 2);
5005
5006                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5007                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
5008
5009                 {
5010                         let events = nodes[1].node.get_and_clear_pending_msg_events();
5011                         assert_eq!(events.len(), 1);
5012                         match events[0] {
5013                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
5014                                         assert_eq!(flags & 0b10, 0b10);
5015                                 },
5016                                 _ => panic!("Unexpected event"),
5017                         }
5018                 }
5019
5020                 // Duplicate the block_connected call since this may happen due to other listeners
5021                 // registering new transactions
5022                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
5023         }
5024
5025         #[test]
5026         fn test_force_close_fail_back() {
5027                 // Check which HTLCs are failed-backwards on channel force-closure
5028                 let mut nodes = create_network(3);
5029                 create_announced_chan_between_nodes(&nodes, 0, 1);
5030                 create_announced_chan_between_nodes(&nodes, 1, 2);
5031
5032                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
5033
5034                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
5035
5036                 let mut payment_event = {
5037                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
5038                         check_added_monitors!(nodes[0], 1);
5039
5040                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5041                         assert_eq!(events.len(), 1);
5042                         SendEvent::from_event(events.remove(0))
5043                 };
5044
5045                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5046                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5047
5048                 let events_1 = nodes[1].node.get_and_clear_pending_events();
5049                 assert_eq!(events_1.len(), 1);
5050                 match events_1[0] {
5051                         Event::PendingHTLCsForwardable { .. } => { },
5052                         _ => panic!("Unexpected event"),
5053                 };
5054
5055                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
5056                 nodes[1].node.process_pending_htlc_forwards();
5057
5058                 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5059                 assert_eq!(events_2.len(), 1);
5060                 payment_event = SendEvent::from_event(events_2.remove(0));
5061                 assert_eq!(payment_event.msgs.len(), 1);
5062
5063                 check_added_monitors!(nodes[1], 1);
5064                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5065                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
5066                 check_added_monitors!(nodes[2], 1);
5067                 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5068
5069                 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
5070                 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
5071                 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
5072
5073                 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
5074                 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
5075                 assert_eq!(events_3.len(), 1);
5076                 match events_3[0] {
5077                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
5078                                 assert_eq!(flags & 0b10, 0b10);
5079                         },
5080                         _ => panic!("Unexpected event"),
5081                 }
5082
5083                 let tx = {
5084                         let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
5085                         // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
5086                         // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
5087                         // back to nodes[1] upon timeout otherwise.
5088                         assert_eq!(node_txn.len(), 1);
5089                         node_txn.remove(0)
5090                 };
5091
5092                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5093                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
5094
5095                 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
5096                 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
5097                 assert_eq!(events_4.len(), 1);
5098                 match events_4[0] {
5099                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
5100                                 assert_eq!(flags & 0b10, 0b10);
5101                         },
5102                         _ => panic!("Unexpected event"),
5103                 }
5104
5105                 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
5106                 {
5107                         let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
5108                         monitors.get_mut(&OutPoint::new(Sha256dHash::from(&payment_event.commitment_msg.channel_id[..]), 0)).unwrap()
5109                                 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
5110                 }
5111                 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
5112                 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
5113                 assert_eq!(node_txn.len(), 1);
5114                 assert_eq!(node_txn[0].input.len(), 1);
5115                 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
5116                 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
5117                 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
5118
5119                 check_spends!(node_txn[0], tx);
5120         }
5121
5122         #[test]
5123         fn test_unconf_chan() {
5124                 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
5125                 let nodes = create_network(2);
5126                 create_announced_chan_between_nodes(&nodes, 0, 1);
5127
5128                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
5129                 assert_eq!(channel_state.by_id.len(), 1);
5130                 assert_eq!(channel_state.short_to_id.len(), 1);
5131                 mem::drop(channel_state);
5132
5133                 let mut headers = Vec::new();
5134                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5135                 headers.push(header.clone());
5136                 for _i in 2..100 {
5137                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5138                         headers.push(header.clone());
5139                 }
5140                 while !headers.is_empty() {
5141                         nodes[0].node.block_disconnected(&headers.pop().unwrap());
5142                 }
5143                 {
5144                         let events = nodes[0].node.get_and_clear_pending_msg_events();
5145                         assert_eq!(events.len(), 1);
5146                         match events[0] {
5147                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
5148                                         assert_eq!(flags & 0b10, 0b10);
5149                                 },
5150                                 _ => panic!("Unexpected event"),
5151                         }
5152                 }
5153                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
5154                 assert_eq!(channel_state.by_id.len(), 0);
5155                 assert_eq!(channel_state.short_to_id.len(), 0);
5156         }
5157
5158         /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
5159         /// for claims/fails they are separated out.
5160         fn reconnect_nodes(node_a: &Node, node_b: &Node, pre_all_htlcs: bool, pending_htlc_adds: (i64, i64), pending_htlc_claims: (usize, usize), pending_cell_htlc_claims: (usize, usize), pending_cell_htlc_fails: (usize, usize), pending_raa: (bool, bool)) {
5161                 let reestablish_1 = node_a.node.peer_connected(&node_b.node.get_our_node_id());
5162                 let reestablish_2 = node_b.node.peer_connected(&node_a.node.get_our_node_id());
5163
5164                 let mut resp_1 = Vec::new();
5165                 for msg in reestablish_1 {
5166                         resp_1.push(node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap());
5167                 }
5168                 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
5169                         check_added_monitors!(node_b, 1);
5170                 } else {
5171                         check_added_monitors!(node_b, 0);
5172                 }
5173
5174                 let mut resp_2 = Vec::new();
5175                 for msg in reestablish_2 {
5176                         resp_2.push(node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg).unwrap());
5177                 }
5178                 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
5179                         check_added_monitors!(node_a, 1);
5180                 } else {
5181                         check_added_monitors!(node_a, 0);
5182                 }
5183
5184                 // We dont yet support both needing updates, as that would require a different commitment dance:
5185                 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
5186                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
5187
5188                 for chan_msgs in resp_1.drain(..) {
5189                         if pre_all_htlcs {
5190                                 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
5191                                 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
5192                                 if !announcement_event.is_empty() {
5193                                         assert_eq!(announcement_event.len(), 1);
5194                                         if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
5195                                                 //TODO: Test announcement_sigs re-sending
5196                                         } else { panic!("Unexpected event!"); }
5197                                 }
5198                         } else {
5199                                 assert!(chan_msgs.0.is_none());
5200                         }
5201                         if pending_raa.0 {
5202                                 assert!(chan_msgs.3 == msgs::RAACommitmentOrder::RevokeAndACKFirst);
5203                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
5204                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
5205                                 check_added_monitors!(node_a, 1);
5206                         } else {
5207                                 assert!(chan_msgs.1.is_none());
5208                         }
5209                         if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
5210                                 let commitment_update = chan_msgs.2.unwrap();
5211                                 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
5212                                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
5213                                 } else {
5214                                         assert!(commitment_update.update_add_htlcs.is_empty());
5215                                 }
5216                                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
5217                                 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
5218                                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
5219                                 for update_add in commitment_update.update_add_htlcs {
5220                                         node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add).unwrap();
5221                                 }
5222                                 for update_fulfill in commitment_update.update_fulfill_htlcs {
5223                                         node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill).unwrap();
5224                                 }
5225                                 for update_fail in commitment_update.update_fail_htlcs {
5226                                         node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail).unwrap();
5227                                 }
5228
5229                                 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
5230                                         commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
5231                                 } else {
5232                                         node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
5233                                         check_added_monitors!(node_a, 1);
5234                                         let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
5235                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
5236                                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
5237                                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
5238                                         check_added_monitors!(node_b, 1);
5239                                 }
5240                         } else {
5241                                 assert!(chan_msgs.2.is_none());
5242                         }
5243                 }
5244
5245                 for chan_msgs in resp_2.drain(..) {
5246                         if pre_all_htlcs {
5247                                 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
5248                                 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
5249                                 if !announcement_event.is_empty() {
5250                                         assert_eq!(announcement_event.len(), 1);
5251                                         if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
5252                                                 //TODO: Test announcement_sigs re-sending
5253                                         } else { panic!("Unexpected event!"); }
5254                                 }
5255                         } else {
5256                                 assert!(chan_msgs.0.is_none());
5257                         }
5258                         if pending_raa.1 {
5259                                 assert!(chan_msgs.3 == msgs::RAACommitmentOrder::RevokeAndACKFirst);
5260                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
5261                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
5262                                 check_added_monitors!(node_b, 1);
5263                         } else {
5264                                 assert!(chan_msgs.1.is_none());
5265                         }
5266                         if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
5267                                 let commitment_update = chan_msgs.2.unwrap();
5268                                 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
5269                                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
5270                                 }
5271                                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
5272                                 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
5273                                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
5274                                 for update_add in commitment_update.update_add_htlcs {
5275                                         node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add).unwrap();
5276                                 }
5277                                 for update_fulfill in commitment_update.update_fulfill_htlcs {
5278                                         node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill).unwrap();
5279                                 }
5280                                 for update_fail in commitment_update.update_fail_htlcs {
5281                                         node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail).unwrap();
5282                                 }
5283
5284                                 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
5285                                         commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
5286                                 } else {
5287                                         node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
5288                                         check_added_monitors!(node_b, 1);
5289                                         let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
5290                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
5291                                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
5292                                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
5293                                         check_added_monitors!(node_a, 1);
5294                                 }
5295                         } else {
5296                                 assert!(chan_msgs.2.is_none());
5297                         }
5298                 }
5299         }
5300
5301         #[test]
5302         fn test_simple_peer_disconnect() {
5303                 // Test that we can reconnect when there are no lost messages
5304                 let nodes = create_network(3);
5305                 create_announced_chan_between_nodes(&nodes, 0, 1);
5306                 create_announced_chan_between_nodes(&nodes, 1, 2);
5307
5308                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5309                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5310                 reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5311
5312                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
5313                 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
5314                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
5315                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
5316
5317                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5318                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5319                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5320
5321                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
5322                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
5323                 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
5324                 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
5325
5326                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5327                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5328
5329                 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
5330                 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
5331
5332                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
5333                 {
5334                         let events = nodes[0].node.get_and_clear_pending_events();
5335                         assert_eq!(events.len(), 2);
5336                         match events[0] {
5337                                 Event::PaymentSent { payment_preimage } => {
5338                                         assert_eq!(payment_preimage, payment_preimage_3);
5339                                 },
5340                                 _ => panic!("Unexpected event"),
5341                         }
5342                         match events[1] {
5343                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
5344                                         assert_eq!(payment_hash, payment_hash_5);
5345                                         assert!(rejected_by_dest);
5346                                 },
5347                                 _ => panic!("Unexpected event"),
5348                         }
5349                 }
5350
5351                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
5352                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
5353         }
5354
5355         fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
5356                 // Test that we can reconnect when in-flight HTLC updates get dropped
5357                 let mut nodes = create_network(2);
5358                 if messages_delivered == 0 {
5359                         create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
5360                         // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
5361                 } else {
5362                         create_announced_chan_between_nodes(&nodes, 0, 1);
5363                 }
5364
5365                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
5366                 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
5367
5368                 let payment_event = {
5369                         nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
5370                         check_added_monitors!(nodes[0], 1);
5371
5372                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5373                         assert_eq!(events.len(), 1);
5374                         SendEvent::from_event(events.remove(0))
5375                 };
5376                 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
5377
5378                 if messages_delivered < 2 {
5379                         // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
5380                 } else {
5381                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5382                         nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
5383                         check_added_monitors!(nodes[1], 1);
5384                         let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5385
5386                         if messages_delivered >= 3 {
5387                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
5388                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5389                                 check_added_monitors!(nodes[0], 1);
5390
5391                                 if messages_delivered >= 4 {
5392                                         nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
5393                                         let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
5394                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
5395                                         check_added_monitors!(nodes[0], 1);
5396
5397                                         if messages_delivered >= 5 {
5398                                                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
5399                                                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5400                                                 check_added_monitors!(nodes[1], 1);
5401                                         }
5402                                 }
5403                         }
5404                 }
5405
5406                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5407                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5408                 if messages_delivered < 2 {
5409                         // Even if the funding_locked messages get exchanged, as long as nothing further was
5410                         // received on either side, both sides will need to resend them.
5411                         reconnect_nodes(&nodes[0], &nodes[1], true, (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
5412                 } else if messages_delivered == 2 {
5413                         // nodes[0] still wants its RAA + commitment_signed
5414                         reconnect_nodes(&nodes[0], &nodes[1], false, (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
5415                 } else if messages_delivered == 3 {
5416                         // nodes[0] still wants its commitment_signed
5417                         reconnect_nodes(&nodes[0], &nodes[1], false, (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
5418                 } else if messages_delivered == 4 {
5419                         // nodes[1] still wants its final RAA
5420                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
5421                 } else if messages_delivered == 5 {
5422                         // Everything was delivered...
5423                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5424                 }
5425
5426                 let events_1 = nodes[1].node.get_and_clear_pending_events();
5427                 assert_eq!(events_1.len(), 1);
5428                 match events_1[0] {
5429                         Event::PendingHTLCsForwardable { .. } => { },
5430                         _ => panic!("Unexpected event"),
5431                 };
5432
5433                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5434                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5435                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5436
5437                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
5438                 nodes[1].node.process_pending_htlc_forwards();
5439
5440                 let events_2 = nodes[1].node.get_and_clear_pending_events();
5441                 assert_eq!(events_2.len(), 1);
5442                 match events_2[0] {
5443                         Event::PaymentReceived { ref payment_hash, amt } => {
5444                                 assert_eq!(payment_hash_1, *payment_hash);
5445                                 assert_eq!(amt, 1000000);
5446                         },
5447                         _ => panic!("Unexpected event"),
5448                 }
5449
5450                 nodes[1].node.claim_funds(payment_preimage_1);
5451                 check_added_monitors!(nodes[1], 1);
5452
5453                 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
5454                 assert_eq!(events_3.len(), 1);
5455                 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
5456                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
5457                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
5458                                 assert!(updates.update_add_htlcs.is_empty());
5459                                 assert!(updates.update_fail_htlcs.is_empty());
5460                                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5461                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
5462                                 assert!(updates.update_fee.is_none());
5463                                 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
5464                         },
5465                         _ => panic!("Unexpected event"),
5466                 };
5467
5468                 if messages_delivered >= 1 {
5469                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
5470
5471                         let events_4 = nodes[0].node.get_and_clear_pending_events();
5472                         assert_eq!(events_4.len(), 1);
5473                         match events_4[0] {
5474                                 Event::PaymentSent { ref payment_preimage } => {
5475                                         assert_eq!(payment_preimage_1, *payment_preimage);
5476                                 },
5477                                 _ => panic!("Unexpected event"),
5478                         }
5479
5480                         if messages_delivered >= 2 {
5481                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
5482                                 check_added_monitors!(nodes[0], 1);
5483                                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5484
5485                                 if messages_delivered >= 3 {
5486                                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
5487                                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5488                                         check_added_monitors!(nodes[1], 1);
5489
5490                                         if messages_delivered >= 4 {
5491                                                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
5492                                                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5493                                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
5494                                                 check_added_monitors!(nodes[1], 1);
5495
5496                                                 if messages_delivered >= 5 {
5497                                                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
5498                                                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5499                                                         check_added_monitors!(nodes[0], 1);
5500                                                 }
5501                                         }
5502                                 }
5503                         }
5504                 }
5505
5506                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5507                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5508                 if messages_delivered < 2 {
5509                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
5510                         //TODO: Deduplicate PaymentSent events, then enable this if:
5511                         //if messages_delivered < 1 {
5512                                 let events_4 = nodes[0].node.get_and_clear_pending_events();
5513                                 assert_eq!(events_4.len(), 1);
5514                                 match events_4[0] {
5515                                         Event::PaymentSent { ref payment_preimage } => {
5516                                                 assert_eq!(payment_preimage_1, *payment_preimage);
5517                                         },
5518                                         _ => panic!("Unexpected event"),
5519                                 }
5520                         //}
5521                 } else if messages_delivered == 2 {
5522                         // nodes[0] still wants its RAA + commitment_signed
5523                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
5524                 } else if messages_delivered == 3 {
5525                         // nodes[0] still wants its commitment_signed
5526                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
5527                 } else if messages_delivered == 4 {
5528                         // nodes[1] still wants its final RAA
5529                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
5530                 } else if messages_delivered == 5 {
5531                         // Everything was delivered...
5532                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5533                 }
5534
5535                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5536                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5537                 reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5538
5539                 // Channel should still work fine...
5540                 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
5541                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
5542         }
5543
5544         #[test]
5545         fn test_drop_messages_peer_disconnect_a() {
5546                 do_test_drop_messages_peer_disconnect(0);
5547                 do_test_drop_messages_peer_disconnect(1);
5548                 do_test_drop_messages_peer_disconnect(2);
5549         }
5550
5551         #[test]
5552         fn test_drop_messages_peer_disconnect_b() {
5553                 do_test_drop_messages_peer_disconnect(3);
5554                 do_test_drop_messages_peer_disconnect(4);
5555                 do_test_drop_messages_peer_disconnect(5);
5556         }
5557
5558         #[test]
5559         fn test_funding_peer_disconnect() {
5560                 // Test that we can lock in our funding tx while disconnected
5561                 let nodes = create_network(2);
5562                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
5563
5564                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5565                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5566
5567                 confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
5568                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
5569                 assert_eq!(events_1.len(), 1);
5570                 match events_1[0] {
5571                         MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
5572                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
5573                         },
5574                         _ => panic!("Unexpected event"),
5575                 }
5576
5577                 confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
5578                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5579                 assert_eq!(events_2.len(), 1);
5580                 match events_2[0] {
5581                         MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
5582                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
5583                         },
5584                         _ => panic!("Unexpected event"),
5585                 }
5586
5587                 reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5588                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5589                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5590                 reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5591
5592                 // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
5593                 // rebroadcasting announcement_signatures upon reconnect.
5594
5595                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), Some(&nodes[0].node.list_usable_channels()), &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
5596                 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
5597                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
5598         }
5599
5600         #[test]
5601         fn test_drop_messages_peer_disconnect_dual_htlc() {
5602                 // Test that we can handle reconnecting when both sides of a channel have pending
5603                 // commitment_updates when we disconnect.
5604                 let mut nodes = create_network(2);
5605                 create_announced_chan_between_nodes(&nodes, 0, 1);
5606
5607                 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
5608
5609                 // Now try to send a second payment which will fail to send
5610                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
5611                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
5612
5613                 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
5614                 check_added_monitors!(nodes[0], 1);
5615
5616                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
5617                 assert_eq!(events_1.len(), 1);
5618                 match events_1[0] {
5619                         MessageSendEvent::UpdateHTLCs { .. } => {},
5620                         _ => panic!("Unexpected event"),
5621                 }
5622
5623                 assert!(nodes[1].node.claim_funds(payment_preimage_1));
5624                 check_added_monitors!(nodes[1], 1);
5625
5626                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5627                 assert_eq!(events_2.len(), 1);
5628                 match events_2[0] {
5629                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
5630                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
5631                                 assert!(update_add_htlcs.is_empty());
5632                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5633                                 assert!(update_fail_htlcs.is_empty());
5634                                 assert!(update_fail_malformed_htlcs.is_empty());
5635                                 assert!(update_fee.is_none());
5636
5637                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
5638                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
5639                                 assert_eq!(events_3.len(), 1);
5640                                 match events_3[0] {
5641                                         Event::PaymentSent { ref payment_preimage } => {
5642                                                 assert_eq!(*payment_preimage, payment_preimage_1);
5643                                         },
5644                                         _ => panic!("Unexpected event"),
5645                                 }
5646
5647                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
5648                                 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
5649                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
5650                                 check_added_monitors!(nodes[0], 1);
5651                         },
5652                         _ => panic!("Unexpected event"),
5653                 }
5654
5655                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5656                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5657
5658                 let reestablish_1 = nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5659                 assert_eq!(reestablish_1.len(), 1);
5660                 let reestablish_2 = nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5661                 assert_eq!(reestablish_2.len(), 1);
5662
5663                 let as_resp = nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
5664                 let bs_resp = nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
5665
5666                 assert!(as_resp.0.is_none());
5667                 assert!(bs_resp.0.is_none());
5668
5669                 assert!(bs_resp.1.is_none());
5670                 assert!(bs_resp.2.is_none());
5671
5672                 assert!(as_resp.3 == msgs::RAACommitmentOrder::CommitmentFirst);
5673
5674                 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
5675                 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
5676                 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
5677                 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
5678                 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
5679                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().update_add_htlcs[0]).unwrap();
5680                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
5681                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5682                 // No commitment_signed so get_event_msg's assert(len == 1) passes
5683                 check_added_monitors!(nodes[1], 1);
5684
5685                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
5686                 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5687                 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
5688                 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
5689                 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
5690                 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
5691                 assert!(bs_second_commitment_signed.update_fee.is_none());
5692                 check_added_monitors!(nodes[1], 1);
5693
5694                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
5695                 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5696                 assert!(as_commitment_signed.update_add_htlcs.is_empty());
5697                 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
5698                 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
5699                 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
5700                 assert!(as_commitment_signed.update_fee.is_none());
5701                 check_added_monitors!(nodes[0], 1);
5702
5703                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
5704                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
5705                 // No commitment_signed so get_event_msg's assert(len == 1) passes
5706                 check_added_monitors!(nodes[0], 1);
5707
5708                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
5709                 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
5710                 // No commitment_signed so get_event_msg's assert(len == 1) passes
5711                 check_added_monitors!(nodes[1], 1);
5712
5713                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
5714                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5715                 check_added_monitors!(nodes[1], 1);
5716
5717                 let events_4 = nodes[1].node.get_and_clear_pending_events();
5718                 assert_eq!(events_4.len(), 1);
5719                 match events_4[0] {
5720                         Event::PendingHTLCsForwardable { .. } => { },
5721                         _ => panic!("Unexpected event"),
5722                 };
5723
5724                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
5725                 nodes[1].node.process_pending_htlc_forwards();
5726
5727                 let events_5 = nodes[1].node.get_and_clear_pending_events();
5728                 assert_eq!(events_5.len(), 1);
5729                 match events_5[0] {
5730                         Event::PaymentReceived { ref payment_hash, amt: _ } => {
5731                                 assert_eq!(payment_hash_2, *payment_hash);
5732                         },
5733                         _ => panic!("Unexpected event"),
5734                 }
5735
5736                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
5737                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5738                 check_added_monitors!(nodes[0], 1);
5739
5740                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
5741         }
5742
5743         #[test]
5744         fn test_simple_monitor_permanent_update_fail() {
5745                 // Test that we handle a simple permanent monitor update failure
5746                 let mut nodes = create_network(2);
5747                 create_announced_chan_between_nodes(&nodes, 0, 1);
5748
5749                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
5750                 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
5751
5752                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
5753                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_1) {} else { panic!(); }
5754                 check_added_monitors!(nodes[0], 1);
5755
5756                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
5757                 assert_eq!(events_1.len(), 1);
5758                 match events_1[0] {
5759                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5760                         _ => panic!("Unexpected event"),
5761                 };
5762
5763                 // TODO: Once we hit the chain with the failure transaction we should check that we get a
5764                 // PaymentFailed event
5765
5766                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5767         }
5768
5769         fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
5770                 // Test that we can recover from a simple temporary monitor update failure optionally with
5771                 // a disconnect in between
5772                 let mut nodes = create_network(2);
5773                 create_announced_chan_between_nodes(&nodes, 0, 1);
5774
5775                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
5776                 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
5777
5778                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
5779                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_1) {} else { panic!(); }
5780                 check_added_monitors!(nodes[0], 1);
5781
5782                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
5783                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5784                 assert_eq!(nodes[0].node.list_channels().len(), 1);
5785
5786                 if disconnect {
5787                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5788                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5789                         reconnect_nodes(&nodes[0], &nodes[1], true, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5790                 }
5791
5792                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
5793                 nodes[0].node.test_restore_channel_monitor();
5794                 check_added_monitors!(nodes[0], 1);
5795
5796                 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
5797                 assert_eq!(events_2.len(), 1);
5798                 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
5799                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
5800                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
5801                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
5802
5803                 expect_pending_htlcs_forwardable!(nodes[1]);
5804
5805                 let events_3 = nodes[1].node.get_and_clear_pending_events();
5806                 assert_eq!(events_3.len(), 1);
5807                 match events_3[0] {
5808                         Event::PaymentReceived { ref payment_hash, amt } => {
5809                                 assert_eq!(payment_hash_1, *payment_hash);
5810                                 assert_eq!(amt, 1000000);
5811                         },
5812                         _ => panic!("Unexpected event"),
5813                 }
5814
5815                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
5816
5817                 // Now set it to failed again...
5818                 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
5819                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
5820                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_2) {} else { panic!(); }
5821                 check_added_monitors!(nodes[0], 1);
5822
5823                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
5824                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5825                 assert_eq!(nodes[0].node.list_channels().len(), 1);
5826
5827                 if disconnect {
5828                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5829                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5830                         reconnect_nodes(&nodes[0], &nodes[1], false, (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
5831                 }
5832
5833                 // ...and make sure we can force-close a TemporaryFailure channel with a PermanentFailure
5834                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
5835                 nodes[0].node.test_restore_channel_monitor();
5836                 check_added_monitors!(nodes[0], 1);
5837
5838                 let events_5 = nodes[0].node.get_and_clear_pending_msg_events();
5839                 assert_eq!(events_5.len(), 1);
5840                 match events_5[0] {
5841                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
5842                         _ => panic!("Unexpected event"),
5843                 }
5844
5845                 // TODO: Once we hit the chain with the failure transaction we should check that we get a
5846                 // PaymentFailed event
5847
5848                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5849         }
5850
5851         #[test]
5852         fn test_simple_monitor_temporary_update_fail() {
5853                 do_test_simple_monitor_temporary_update_fail(false);
5854                 do_test_simple_monitor_temporary_update_fail(true);
5855         }
5856
5857         fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
5858                 let disconnect_flags = 8 | 16;
5859
5860                 // Test that we can recover from a temporary monitor update failure with some in-flight
5861                 // HTLCs going on at the same time potentially with some disconnection thrown in.
5862                 // * First we route a payment, then get a temporary monitor update failure when trying to
5863                 //   route a second payment. We then claim the first payment.
5864                 // * If disconnect_count is set, we will disconnect at this point (which is likely as
5865                 //   TemporaryFailure likely indicates net disconnect which resulted in failing to update
5866                 //   the ChannelMonitor on a watchtower).
5867                 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
5868                 //   immediately, otherwise we wait sconnect and deliver them via the reconnect
5869                 //   channel_reestablish processing (ie disconnect_count & 16 makes no sense if
5870                 //   disconnect_count & !disconnect_flags is 0).
5871                 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
5872                 //   through message sending, potentially disconnect/reconnecting multiple times based on
5873                 //   disconnect_count, to get the update_fulfill_htlc through.
5874                 // * We then walk through more message exchanges to get the original update_add_htlc
5875                 //   through, swapping message ordering based on disconnect_count & 8 and optionally
5876                 //   disconnect/reconnecting based on disconnect_count.
5877                 let mut nodes = create_network(2);
5878                 create_announced_chan_between_nodes(&nodes, 0, 1);
5879
5880                 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
5881
5882                 // Now try to send a second payment which will fail to send
5883                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
5884                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
5885
5886                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
5887                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_2) {} else { panic!(); }
5888                 check_added_monitors!(nodes[0], 1);
5889
5890                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
5891                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5892                 assert_eq!(nodes[0].node.list_channels().len(), 1);
5893
5894                 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
5895                 // but nodes[0] won't respond since it is frozen.
5896                 assert!(nodes[1].node.claim_funds(payment_preimage_1));
5897                 check_added_monitors!(nodes[1], 1);
5898                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
5899                 assert_eq!(events_2.len(), 1);
5900                 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
5901                         MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fulfill_htlcs, ref update_fail_htlcs, ref update_fail_malformed_htlcs, ref update_fee, ref commitment_signed } } => {
5902                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
5903                                 assert!(update_add_htlcs.is_empty());
5904                                 assert_eq!(update_fulfill_htlcs.len(), 1);
5905                                 assert!(update_fail_htlcs.is_empty());
5906                                 assert!(update_fail_malformed_htlcs.is_empty());
5907                                 assert!(update_fee.is_none());
5908
5909                                 if (disconnect_count & 16) == 0 {
5910                                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
5911                                         let events_3 = nodes[0].node.get_and_clear_pending_events();
5912                                         assert_eq!(events_3.len(), 1);
5913                                         match events_3[0] {
5914                                                 Event::PaymentSent { ref payment_preimage } => {
5915                                                         assert_eq!(*payment_preimage, payment_preimage_1);
5916                                                 },
5917                                                 _ => panic!("Unexpected event"),
5918                                         }
5919
5920                                         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::IgnoreError) }) = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed) {
5921                                                 assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
5922                                         } else { panic!(); }
5923                                 }
5924
5925                                 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
5926                         },
5927                         _ => panic!("Unexpected event"),
5928                 };
5929
5930                 if disconnect_count & !disconnect_flags > 0 {
5931                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5932                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5933                 }
5934
5935                 // Now fix monitor updating...
5936                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
5937                 nodes[0].node.test_restore_channel_monitor();
5938                 check_added_monitors!(nodes[0], 1);
5939
5940                 macro_rules! disconnect_reconnect_peers { () => { {
5941                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5942                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5943
5944                         let reestablish_1 = nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5945                         assert_eq!(reestablish_1.len(), 1);
5946                         let reestablish_2 = nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5947                         assert_eq!(reestablish_2.len(), 1);
5948
5949                         let as_resp = nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
5950                         let bs_resp = nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
5951
5952                         assert!(as_resp.0.is_none());
5953                         assert!(bs_resp.0.is_none());
5954
5955                         (reestablish_1, reestablish_2, as_resp, bs_resp)
5956                 } } }
5957
5958                 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
5959                         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
5960                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5961
5962                         let reestablish_1 = nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5963                         assert_eq!(reestablish_1.len(), 1);
5964                         let reestablish_2 = nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5965                         assert_eq!(reestablish_2.len(), 1);
5966
5967                         let mut as_resp = nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
5968                         check_added_monitors!(nodes[0], 0);
5969                         let mut bs_resp = nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
5970                         check_added_monitors!(nodes[1], 0);
5971
5972                         assert!(as_resp.0.is_none());
5973                         assert!(bs_resp.0.is_none());
5974
5975                         assert!(bs_resp.1.is_none());
5976                         if (disconnect_count & 16) == 0 {
5977                                 assert!(bs_resp.2.is_none());
5978
5979                                 assert!(as_resp.1.is_some());
5980                                 assert!(as_resp.2.is_some());
5981                                 assert!(as_resp.3 == msgs::RAACommitmentOrder::CommitmentFirst);
5982                         } else {
5983                                 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
5984                                 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
5985                                 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
5986                                 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
5987                                 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
5988                                 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
5989
5990                                 assert!(as_resp.1.is_none());
5991
5992                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().update_fulfill_htlcs[0]).unwrap();
5993                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
5994                                 assert_eq!(events_3.len(), 1);
5995                                 match events_3[0] {
5996                                         Event::PaymentSent { ref payment_preimage } => {
5997                                                 assert_eq!(*payment_preimage, payment_preimage_1);
5998                                         },
5999                                         _ => panic!("Unexpected event"),
6000                                 }
6001
6002                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed).unwrap();
6003                                 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6004                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6005                                 check_added_monitors!(nodes[0], 1);
6006
6007                                 as_resp.1 = Some(as_resp_raa);
6008                                 bs_resp.2 = None;
6009                         }
6010
6011                         if disconnect_count & !disconnect_flags > 1 {
6012                                 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
6013
6014                                 if (disconnect_count & 16) == 0 {
6015                                         assert!(reestablish_1 == second_reestablish_1);
6016                                         assert!(reestablish_2 == second_reestablish_2);
6017                                 }
6018                                 assert!(as_resp == second_as_resp);
6019                                 assert!(bs_resp == second_bs_resp);
6020                         }
6021
6022                         (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
6023                 } else {
6024                         let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
6025                         assert_eq!(events_4.len(), 2);
6026                         (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
6027                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
6028                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6029                                         msg.clone()
6030                                 },
6031                                 _ => panic!("Unexpected event"),
6032                         })
6033                 };
6034
6035                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
6036
6037                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6038                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
6039                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6040                 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
6041                 check_added_monitors!(nodes[1], 1);
6042
6043                 if disconnect_count & !disconnect_flags > 2 {
6044                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
6045
6046                         assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
6047                         assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
6048
6049                         assert!(as_resp.2.is_none());
6050                         assert!(bs_resp.2.is_none());
6051                 }
6052
6053                 let as_commitment_update;
6054                 let bs_second_commitment_update;
6055
6056                 macro_rules! handle_bs_raa { () => {
6057                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6058                         as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6059                         assert!(as_commitment_update.update_add_htlcs.is_empty());
6060                         assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
6061                         assert!(as_commitment_update.update_fail_htlcs.is_empty());
6062                         assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
6063                         assert!(as_commitment_update.update_fee.is_none());
6064                         check_added_monitors!(nodes[0], 1);
6065                 } }
6066
6067                 macro_rules! handle_initial_raa { () => {
6068                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack).unwrap();
6069                         bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6070                         assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
6071                         assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
6072                         assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
6073                         assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
6074                         assert!(bs_second_commitment_update.update_fee.is_none());
6075                         check_added_monitors!(nodes[1], 1);
6076                 } }
6077
6078                 if (disconnect_count & 8) == 0 {
6079                         handle_bs_raa!();
6080
6081                         if disconnect_count & !disconnect_flags > 3 {
6082                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
6083
6084                                 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
6085                                 assert!(bs_resp.1.is_none());
6086
6087                                 assert!(as_resp.2.unwrap() == as_commitment_update);
6088                                 assert!(bs_resp.2.is_none());
6089
6090                                 assert!(as_resp.3 == msgs::RAACommitmentOrder::RevokeAndACKFirst);
6091                         }
6092
6093                         handle_initial_raa!();
6094
6095                         if disconnect_count & !disconnect_flags > 4 {
6096                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
6097
6098                                 assert!(as_resp.1.is_none());
6099                                 assert!(bs_resp.1.is_none());
6100
6101                                 assert!(as_resp.2.unwrap() == as_commitment_update);
6102                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
6103                         }
6104                 } else {
6105                         handle_initial_raa!();
6106
6107                         if disconnect_count & !disconnect_flags > 3 {
6108                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
6109
6110                                 assert!(as_resp.1.is_none());
6111                                 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
6112
6113                                 assert!(as_resp.2.is_none());
6114                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
6115
6116                                 assert!(bs_resp.3 == msgs::RAACommitmentOrder::RevokeAndACKFirst);
6117                         }
6118
6119                         handle_bs_raa!();
6120
6121                         if disconnect_count & !disconnect_flags > 4 {
6122                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
6123
6124                                 assert!(as_resp.1.is_none());
6125                                 assert!(bs_resp.1.is_none());
6126
6127                                 assert!(as_resp.2.unwrap() == as_commitment_update);
6128                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
6129                         }
6130                 }
6131
6132                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed).unwrap();
6133                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6134                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6135                 check_added_monitors!(nodes[0], 1);
6136
6137                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed).unwrap();
6138                 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6139                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6140                 check_added_monitors!(nodes[1], 1);
6141
6142                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6143                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6144                 check_added_monitors!(nodes[1], 1);
6145
6146                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
6147                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6148                 check_added_monitors!(nodes[0], 1);
6149
6150                 expect_pending_htlcs_forwardable!(nodes[1]);
6151
6152                 let events_5 = nodes[1].node.get_and_clear_pending_events();
6153                 assert_eq!(events_5.len(), 1);
6154                 match events_5[0] {
6155                         Event::PaymentReceived { ref payment_hash, amt } => {
6156                                 assert_eq!(payment_hash_2, *payment_hash);
6157                                 assert_eq!(amt, 1000000);
6158                         },
6159                         _ => panic!("Unexpected event"),
6160                 }
6161
6162                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
6163         }
6164
6165         #[test]
6166         fn test_monitor_temporary_update_fail_a() {
6167                 do_test_monitor_temporary_update_fail(0);
6168                 do_test_monitor_temporary_update_fail(1);
6169                 do_test_monitor_temporary_update_fail(2);
6170                 do_test_monitor_temporary_update_fail(3);
6171                 do_test_monitor_temporary_update_fail(4);
6172                 do_test_monitor_temporary_update_fail(5);
6173         }
6174
6175         #[test]
6176         fn test_monitor_temporary_update_fail_b() {
6177                 do_test_monitor_temporary_update_fail(2 | 8);
6178                 do_test_monitor_temporary_update_fail(3 | 8);
6179                 do_test_monitor_temporary_update_fail(4 | 8);
6180                 do_test_monitor_temporary_update_fail(5 | 8);
6181         }
6182
6183         #[test]
6184         fn test_monitor_temporary_update_fail_c() {
6185                 do_test_monitor_temporary_update_fail(1 | 16);
6186                 do_test_monitor_temporary_update_fail(2 | 16);
6187                 do_test_monitor_temporary_update_fail(3 | 16);
6188                 do_test_monitor_temporary_update_fail(2 | 8 | 16);
6189                 do_test_monitor_temporary_update_fail(3 | 8 | 16);
6190         }
6191
6192         #[test]
6193         fn test_invalid_channel_announcement() {
6194                 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
6195                 let secp_ctx = Secp256k1::new();
6196                 let nodes = create_network(2);
6197
6198                 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
6199
6200                 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
6201                 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
6202                 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
6203                 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
6204
6205                 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
6206
6207                 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
6208                 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
6209
6210                 let as_network_key = nodes[0].node.get_our_node_id();
6211                 let bs_network_key = nodes[1].node.get_our_node_id();
6212
6213                 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
6214
6215                 let mut chan_announcement;
6216
6217                 macro_rules! dummy_unsigned_msg {
6218                         () => {
6219                                 msgs::UnsignedChannelAnnouncement {
6220                                         features: msgs::GlobalFeatures::new(),
6221                                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
6222                                         short_channel_id: as_chan.get_short_channel_id().unwrap(),
6223                                         node_id_1: if were_node_one { as_network_key } else { bs_network_key },
6224                                         node_id_2: if were_node_one { bs_network_key } else { as_network_key },
6225                                         bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
6226                                         bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
6227                                         excess_data: Vec::new(),
6228                                 };
6229                         }
6230                 }
6231
6232                 macro_rules! sign_msg {
6233                         ($unsigned_msg: expr) => {
6234                                 let msghash = Message::from_slice(&Sha256dHash::from_data(&$unsigned_msg.encode()[..])[..]).unwrap();
6235                                 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
6236                                 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
6237                                 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].node.our_network_key);
6238                                 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].node.our_network_key);
6239                                 chan_announcement = msgs::ChannelAnnouncement {
6240                                         node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
6241                                         node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
6242                                         bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
6243                                         bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
6244                                         contents: $unsigned_msg
6245                                 }
6246                         }
6247                 }
6248
6249                 let unsigned_msg = dummy_unsigned_msg!();
6250                 sign_msg!(unsigned_msg);
6251                 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
6252                 let _ = nodes[0].router.handle_htlc_fail_channel_update(&msgs::HTLCFailChannelUpdate::ChannelClosed { short_channel_id : as_chan.get_short_channel_id().unwrap(), is_permanent: false } );
6253
6254                 // Configured with Network::Testnet
6255                 let mut unsigned_msg = dummy_unsigned_msg!();
6256                 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
6257                 sign_msg!(unsigned_msg);
6258                 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
6259
6260                 let mut unsigned_msg = dummy_unsigned_msg!();
6261                 unsigned_msg.chain_hash = Sha256dHash::from_data(&[1,2,3,4,5,6,7,8,9]);
6262                 sign_msg!(unsigned_msg);
6263                 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
6264         }
6265 }