Track HTLCSource in ChannelMonitor
[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::util::hash::{BitcoinHash, Sha256dHash};
16
17 use secp256k1::key::{SecretKey,PublicKey};
18 use secp256k1::{Secp256k1,Message};
19 use secp256k1::ecdh::SharedSecret;
20 use secp256k1;
21
22 use chain::chaininterface::{BroadcasterInterface,ChainListener,ChainWatchInterface,FeeEstimator};
23 use chain::transaction::OutPoint;
24 use ln::channel::{Channel, ChannelError};
25 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, ManyChannelMonitor, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS};
26 use ln::router::{Route,RouteHop};
27 use ln::msgs;
28 use ln::msgs::{ChannelMessageHandler, DecodeError, HandleError};
29 use chain::keysinterface::KeysInterface;
30 use util::config::UserConfig;
31 use util::{byte_utils, events, internal_traits, rng};
32 use util::sha2::Sha256;
33 use util::ser::{Readable, ReadableArgs, Writeable, Writer};
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::{cmp, ptr, mem};
45 use std::collections::{HashMap, hash_map, HashSet};
46 use std::io::Cursor;
47 use std::sync::{Arc, Mutex, MutexGuard, RwLock};
48 use std::sync::atomic::{AtomicUsize, Ordering};
49 use std::time::{Instant,Duration};
50
51 /// We hold various information about HTLC relay in the HTLC objects in Channel itself:
52 ///
53 /// Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
54 /// forward the HTLC with information it will give back to us when it does so, or if it should Fail
55 /// the HTLC with the relevant message for the Channel to handle giving to the remote peer.
56 ///
57 /// When a Channel forwards an HTLC to its peer, it will give us back the PendingForwardHTLCInfo
58 /// which we will use to construct an outbound HTLC, with a relevant HTLCSource::PreviousHopData
59 /// filled in to indicate where it came from (which we can use to either fail-backwards or fulfill
60 /// the HTLC backwards along the relevant path).
61 /// Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
62 /// our payment, which we can use to decode errors or inform the user that the payment was sent.
63 mod channel_held_info {
64         use ln::msgs;
65         use ln::router::Route;
66         use secp256k1::key::SecretKey;
67
68         /// Stores the info we will need to send when we want to forward an HTLC onwards
69         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
70         pub struct PendingForwardHTLCInfo {
71                 pub(super) onion_packet: Option<msgs::OnionPacket>,
72                 pub(super) incoming_shared_secret: [u8; 32],
73                 pub(super) payment_hash: [u8; 32],
74                 pub(super) short_channel_id: u64,
75                 pub(super) amt_to_forward: u64,
76                 pub(super) outgoing_cltv_value: u32,
77         }
78
79         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
80         pub enum HTLCFailureMsg {
81                 Relay(msgs::UpdateFailHTLC),
82                 Malformed(msgs::UpdateFailMalformedHTLC),
83         }
84
85         /// Stores whether we can't forward an HTLC or relevant forwarding info
86         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
87         pub enum PendingHTLCStatus {
88                 Forward(PendingForwardHTLCInfo),
89                 Fail(HTLCFailureMsg),
90         }
91
92         /// Tracks the inbound corresponding to an outbound HTLC
93         #[derive(Clone, PartialEq)]
94         pub struct HTLCPreviousHopData {
95                 pub(super) short_channel_id: u64,
96                 pub(super) htlc_id: u64,
97                 pub(super) incoming_packet_shared_secret: [u8; 32],
98         }
99
100         /// Tracks the inbound corresponding to an outbound HTLC
101         #[derive(Clone, PartialEq)]
102         pub enum HTLCSource {
103                 PreviousHopData(HTLCPreviousHopData),
104                 OutboundRoute {
105                         route: Route,
106                         session_priv: SecretKey,
107                         /// Technically we can recalculate this from the route, but we cache it here to avoid
108                         /// doing a double-pass on route when we get a failure back
109                         first_hop_htlc_msat: u64,
110                 },
111         }
112         #[cfg(test)]
113         impl HTLCSource {
114                 pub fn dummy() -> Self {
115                         HTLCSource::OutboundRoute {
116                                 route: Route { hops: Vec::new() },
117                                 session_priv: SecretKey::from_slice(&::secp256k1::Secp256k1::without_caps(), &[1; 32]).unwrap(),
118                                 first_hop_htlc_msat: 0,
119                         }
120                 }
121         }
122
123         #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
124         pub(crate) enum HTLCFailReason {
125                 ErrorPacket {
126                         err: msgs::OnionErrorPacket,
127                 },
128                 Reason {
129                         failure_code: u16,
130                         data: Vec<u8>,
131                 }
132         }
133 }
134 pub(super) use self::channel_held_info::*;
135
136 type ShutdownResult = (Vec<Transaction>, Vec<(HTLCSource, [u8; 32])>);
137
138 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
139 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
140 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
141 /// channel_state lock. We then return the set of things that need to be done outside the lock in
142 /// this struct and call handle_error!() on it.
143 struct MsgHandleErrInternal {
144         err: msgs::HandleError,
145         shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
146 }
147 impl MsgHandleErrInternal {
148         #[inline]
149         fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
150                 Self {
151                         err: HandleError {
152                                 err,
153                                 action: Some(msgs::ErrorAction::SendErrorMessage {
154                                         msg: msgs::ErrorMessage {
155                                                 channel_id,
156                                                 data: err.to_string()
157                                         },
158                                 }),
159                         },
160                         shutdown_finish: None,
161                 }
162         }
163         #[inline]
164         fn from_no_close(err: msgs::HandleError) -> Self {
165                 Self { err, shutdown_finish: None }
166         }
167         #[inline]
168         fn from_finish_shutdown(err: &'static str, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
169                 Self {
170                         err: HandleError {
171                                 err,
172                                 action: Some(msgs::ErrorAction::SendErrorMessage {
173                                         msg: msgs::ErrorMessage {
174                                                 channel_id,
175                                                 data: err.to_string()
176                                         },
177                                 }),
178                         },
179                         shutdown_finish: Some((shutdown_res, channel_update)),
180                 }
181         }
182         #[inline]
183         fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
184                 Self {
185                         err: match err {
186                                 ChannelError::Ignore(msg) => HandleError {
187                                         err: msg,
188                                         action: Some(msgs::ErrorAction::IgnoreError),
189                                 },
190                                 ChannelError::Close(msg) => HandleError {
191                                         err: msg,
192                                         action: Some(msgs::ErrorAction::SendErrorMessage {
193                                                 msg: msgs::ErrorMessage {
194                                                         channel_id,
195                                                         data: msg.to_string()
196                                                 },
197                                         }),
198                                 },
199                         },
200                         shutdown_finish: None,
201                 }
202         }
203 }
204
205 /// Pass to fail_htlc_backwwards to indicate the reason to fail the payment
206 /// after a PaymentReceived event.
207 #[derive(PartialEq)]
208 pub enum PaymentFailReason {
209         /// Indicate the preimage for payment_hash is not known after a PaymentReceived event
210         PreimageUnknown,
211         /// Indicate the payment amount is incorrect ( received is < expected or > 2*expected ) after a PaymentReceived event
212         AmountMismatch,
213 }
214
215 /// We hold back HTLCs we intend to relay for a random interval in the range (this, 5*this). This
216 /// provides some limited amount of privacy. Ideally this would range from somewhere like 1 second
217 /// to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly. We could
218 /// probably increase this significantly.
219 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u32 = 50;
220
221 struct HTLCForwardInfo {
222         prev_short_channel_id: u64,
223         prev_htlc_id: u64,
224         forward_info: PendingForwardHTLCInfo,
225 }
226
227 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
228 /// be sent in the order they appear in the return value, however sometimes the order needs to be
229 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
230 /// they were originally sent). In those cases, this enum is also returned.
231 #[derive(Clone, PartialEq)]
232 pub(super) enum RAACommitmentOrder {
233         /// Send the CommitmentUpdate messages first
234         CommitmentFirst,
235         /// Send the RevokeAndACK message first
236         RevokeAndACKFirst,
237 }
238
239 struct ChannelHolder {
240         by_id: HashMap<[u8; 32], Channel>,
241         short_to_id: HashMap<u64, [u8; 32]>,
242         next_forward: Instant,
243         /// short channel id -> forward infos. Key of 0 means payments received
244         /// Note that while this is held in the same mutex as the channels themselves, no consistency
245         /// guarantees are made about there existing a channel with the short id here, nor the short
246         /// ids in the PendingForwardHTLCInfo!
247         forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
248         /// Note that while this is held in the same mutex as the channels themselves, no consistency
249         /// guarantees are made about the channels given here actually existing anymore by the time you
250         /// go to read them!
251         claimable_htlcs: HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
252         /// Messages to send to peers - pushed to in the same lock that they are generated in (except
253         /// for broadcast messages, where ordering isn't as strict).
254         pending_msg_events: Vec<events::MessageSendEvent>,
255 }
256 struct MutChannelHolder<'a> {
257         by_id: &'a mut HashMap<[u8; 32], Channel>,
258         short_to_id: &'a mut HashMap<u64, [u8; 32]>,
259         next_forward: &'a mut Instant,
260         forward_htlcs: &'a mut HashMap<u64, Vec<HTLCForwardInfo>>,
261         claimable_htlcs: &'a mut HashMap<[u8; 32], Vec<HTLCPreviousHopData>>,
262         pending_msg_events: &'a mut Vec<events::MessageSendEvent>,
263 }
264 impl ChannelHolder {
265         fn borrow_parts(&mut self) -> MutChannelHolder {
266                 MutChannelHolder {
267                         by_id: &mut self.by_id,
268                         short_to_id: &mut self.short_to_id,
269                         next_forward: &mut self.next_forward,
270                         forward_htlcs: &mut self.forward_htlcs,
271                         claimable_htlcs: &mut self.claimable_htlcs,
272                         pending_msg_events: &mut self.pending_msg_events,
273                 }
274         }
275 }
276
277 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
278 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
279
280 /// Manager which keeps track of a number of channels and sends messages to the appropriate
281 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
282 ///
283 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
284 /// to individual Channels.
285 ///
286 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
287 /// all peers during write/read (though does not modify this instance, only the instance being
288 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
289 /// called funding_transaction_generated for outbound channels).
290 ///
291 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
292 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
293 /// returning from ManyChannelMonitor::add_update_monitor, with ChannelManagers, writing updates
294 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
295 /// the serialization process). If the deserialized version is out-of-date compared to the
296 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
297 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
298 ///
299 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelManager), which
300 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
301 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
302 /// block_connected() to step towards your best block) upon deserialization before using the
303 /// object!
304 pub struct ChannelManager {
305         default_configuration: UserConfig,
306         genesis_hash: Sha256dHash,
307         fee_estimator: Arc<FeeEstimator>,
308         monitor: Arc<ManyChannelMonitor>,
309         chain_monitor: Arc<ChainWatchInterface>,
310         tx_broadcaster: Arc<BroadcasterInterface>,
311
312         latest_block_height: AtomicUsize,
313         last_block_hash: Mutex<Sha256dHash>,
314         secp_ctx: Secp256k1<secp256k1::All>,
315
316         channel_state: Mutex<ChannelHolder>,
317         our_network_key: SecretKey,
318
319         pending_events: Mutex<Vec<events::Event>>,
320         /// Used when we have to take a BIG lock to make sure everything is self-consistent.
321         /// Essentially just when we're serializing ourselves out.
322         /// Taken first everywhere where we are making changes before any other locks.
323         total_consistency_lock: RwLock<()>,
324
325         keys_manager: Arc<KeysInterface>,
326
327         logger: Arc<Logger>,
328 }
329
330 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
331 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
332 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
333 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
334 /// CLTV_CLAIM_BUFFER point (we static assert that its at least 3 blocks more).
335 const CLTV_EXPIRY_DELTA: u16 = 6 * 24 * 2; //TODO?
336 const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
337
338 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + 2*HTLC_FAIL_TIMEOUT_BLOCKS, ie that
339 // if the next-hop peer fails the HTLC within HTLC_FAIL_TIMEOUT_BLOCKS then we'll still have
340 // HTLC_FAIL_TIMEOUT_BLOCKS left to fail it backwards ourselves before hitting the
341 // CLTV_CLAIM_BUFFER point and failing the channel on-chain to time out the HTLC.
342 #[deny(const_err)]
343 #[allow(dead_code)]
344 const CHECK_CLTV_EXPIRY_SANITY: u32 = CLTV_EXPIRY_DELTA as u32 - 2*HTLC_FAIL_TIMEOUT_BLOCKS - CLTV_CLAIM_BUFFER;
345
346 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
347 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
348 #[deny(const_err)]
349 #[allow(dead_code)]
350 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - HTLC_FAIL_TIMEOUT_BLOCKS - 2*CLTV_CLAIM_BUFFER;
351
352 macro_rules! secp_call {
353         ( $res: expr, $err: expr ) => {
354                 match $res {
355                         Ok(key) => key,
356                         Err(_) => return Err($err),
357                 }
358         };
359 }
360
361 struct OnionKeys {
362         #[cfg(test)]
363         shared_secret: SharedSecret,
364         #[cfg(test)]
365         blinding_factor: [u8; 32],
366         ephemeral_pubkey: PublicKey,
367         rho: [u8; 32],
368         mu: [u8; 32],
369 }
370
371 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
372 pub struct ChannelDetails {
373         /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
374         /// thereafter this is the txid of the funding transaction xor the funding transaction output).
375         /// Note that this means this value is *not* persistent - it can change once during the
376         /// lifetime of the channel.
377         pub channel_id: [u8; 32],
378         /// The position of the funding transaction in the chain. None if the funding transaction has
379         /// not yet been confirmed and the channel fully opened.
380         pub short_channel_id: Option<u64>,
381         /// The node_id of our counterparty
382         pub remote_network_id: PublicKey,
383         /// The value, in satoshis, of this channel as appears in the funding output
384         pub channel_value_satoshis: u64,
385         /// The user_id passed in to create_channel, or 0 if the channel was inbound.
386         pub user_id: u64,
387 }
388
389 macro_rules! handle_error {
390         ($self: ident, $internal: expr, $their_node_id: expr) => {
391                 match $internal {
392                         Ok(msg) => Ok(msg),
393                         Err(MsgHandleErrInternal { err, shutdown_finish }) => {
394                                 if let Some((shutdown_res, update_option)) = shutdown_finish {
395                                         $self.finish_force_close_channel(shutdown_res);
396                                         if let Some(update) = update_option {
397                                                 let mut channel_state = $self.channel_state.lock().unwrap();
398                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
399                                                         msg: update
400                                                 });
401                                         }
402                                 }
403                                 Err(err)
404                         },
405                 }
406         }
407 }
408
409 macro_rules! break_chan_entry {
410         ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
411                 match $res {
412                         Ok(res) => res,
413                         Err(ChannelError::Ignore(msg)) => {
414                                 break Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
415                         },
416                         Err(ChannelError::Close(msg)) => {
417                                 let (channel_id, mut chan) = $entry.remove_entry();
418                                 if let Some(short_id) = chan.get_short_channel_id() {
419                                         $channel_state.short_to_id.remove(&short_id);
420                                 }
421                                 break Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
422                         },
423                 }
424         }
425 }
426
427 macro_rules! try_chan_entry {
428         ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
429                 match $res {
430                         Ok(res) => res,
431                         Err(ChannelError::Ignore(msg)) => {
432                                 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
433                         },
434                         Err(ChannelError::Close(msg)) => {
435                                 let (channel_id, mut chan) = $entry.remove_entry();
436                                 if let Some(short_id) = chan.get_short_channel_id() {
437                                         $channel_state.short_to_id.remove(&short_id);
438                                 }
439                                 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
440                         },
441                 }
442         }
443 }
444
445 macro_rules! return_monitor_err {
446         ($self: expr, $err: expr, $channel_state: expr, $entry: expr, $action_type: path) => {
447                 return_monitor_err!($self, $err, $channel_state, $entry, $action_type, Vec::new(), Vec::new())
448         };
449         ($self: expr, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $raa_first_dropped_cs: expr) => {
450                 if $action_type != RAACommitmentOrder::RevokeAndACKFirst { panic!("Bad return_monitor_err call!"); }
451                 return_monitor_err!($self, $err, $channel_state, $entry, $action_type, Vec::new(), Vec::new(), $raa_first_dropped_cs)
452         };
453         ($self: expr, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $failed_forwards: expr, $failed_fails: expr) => {
454                 return_monitor_err!($self, $err, $channel_state, $entry, $action_type, $failed_forwards, $failed_fails, false)
455         };
456         ($self: expr, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $failed_forwards: expr, $failed_fails: expr, $raa_first_dropped_cs: expr) => {
457                 match $err {
458                         ChannelMonitorUpdateErr::PermanentFailure => {
459                                 let (channel_id, mut chan) = $entry.remove_entry();
460                                 if let Some(short_id) = chan.get_short_channel_id() {
461                                         $channel_state.short_to_id.remove(&short_id);
462                                 }
463                                 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
464                                 // chain in a confused state! We need to move them into the ChannelMonitor which
465                                 // will be responsible for failing backwards once things confirm on-chain.
466                                 // It's ok that we drop $failed_forwards here - at this point we'd rather they
467                                 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
468                                 // us bother trying to claim it just to forward on to another peer. If we're
469                                 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
470                                 // given up the preimage yet, so might as well just wait until the payment is
471                                 // retried, avoiding the on-chain fees.
472                                 return Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
473                         },
474                         ChannelMonitorUpdateErr::TemporaryFailure => {
475                                 $entry.get_mut().monitor_update_failed($action_type, $failed_forwards, $failed_fails, $raa_first_dropped_cs);
476                                 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor"), *$entry.key()));
477                         },
478                 }
479         }
480 }
481
482 // Does not break in case of TemporaryFailure!
483 macro_rules! maybe_break_monitor_err {
484         ($self: expr, $err: expr, $channel_state: expr, $entry: expr, $action_type: path) => {
485                 match $err {
486                         ChannelMonitorUpdateErr::PermanentFailure => {
487                                 let (channel_id, mut chan) = $entry.remove_entry();
488                                 if let Some(short_id) = chan.get_short_channel_id() {
489                                         $channel_state.short_to_id.remove(&short_id);
490                                 }
491                                 break Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
492                         },
493                         ChannelMonitorUpdateErr::TemporaryFailure => {
494                                 $entry.get_mut().monitor_update_failed($action_type, Vec::new(), Vec::new(), false);
495                         },
496                 }
497         }
498 }
499
500 impl ChannelManager {
501         /// Constructs a new ChannelManager to hold several channels and route between them.
502         ///
503         /// This is the main "logic hub" for all channel-related actions, and implements
504         /// ChannelMessageHandler.
505         ///
506         /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
507         ///
508         /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
509         pub fn new(network: Network, feeest: Arc<FeeEstimator>, monitor: Arc<ManyChannelMonitor>, chain_monitor: Arc<ChainWatchInterface>, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>,keys_manager: Arc<KeysInterface>, config: UserConfig) -> Result<Arc<ChannelManager>, secp256k1::Error> {
510                 let secp_ctx = Secp256k1::new();
511
512                 let res = Arc::new(ChannelManager {
513                         default_configuration: config.clone(),
514                         genesis_hash: genesis_block(network).header.bitcoin_hash(),
515                         fee_estimator: feeest.clone(),
516                         monitor: monitor.clone(),
517                         chain_monitor,
518                         tx_broadcaster,
519
520                         latest_block_height: AtomicUsize::new(0), //TODO: Get an init value
521                         last_block_hash: Mutex::new(Default::default()),
522                         secp_ctx,
523
524                         channel_state: Mutex::new(ChannelHolder{
525                                 by_id: HashMap::new(),
526                                 short_to_id: HashMap::new(),
527                                 next_forward: Instant::now(),
528                                 forward_htlcs: HashMap::new(),
529                                 claimable_htlcs: HashMap::new(),
530                                 pending_msg_events: Vec::new(),
531                         }),
532                         our_network_key: keys_manager.get_node_secret(),
533
534                         pending_events: Mutex::new(Vec::new()),
535                         total_consistency_lock: RwLock::new(()),
536
537                         keys_manager,
538
539                         logger,
540                 });
541                 let weak_res = Arc::downgrade(&res);
542                 res.chain_monitor.register_listener(weak_res);
543                 Ok(res)
544         }
545
546         /// Creates a new outbound channel to the given remote node and with the given value.
547         ///
548         /// user_id will be provided back as user_channel_id in FundingGenerationReady and
549         /// FundingBroadcastSafe events to allow tracking of which events correspond with which
550         /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
551         /// may wish to avoid using 0 for user_id here.
552         ///
553         /// If successful, will generate a SendOpenChannel message event, so you should probably poll
554         /// PeerManager::process_events afterwards.
555         ///
556         /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
557         /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
558         pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
559                 if channel_value_satoshis < 1000 {
560                         return Err(APIError::APIMisuseError { err: "channel_value must be at least 1000 satoshis" });
561                 }
562
563                 let channel = Channel::new_outbound(&*self.fee_estimator, &self.keys_manager, their_network_key, channel_value_satoshis, push_msat, user_id, Arc::clone(&self.logger), &self.default_configuration)?;
564                 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
565
566                 let _ = self.total_consistency_lock.read().unwrap();
567                 let mut channel_state = self.channel_state.lock().unwrap();
568                 match channel_state.by_id.entry(channel.channel_id()) {
569                         hash_map::Entry::Occupied(_) => {
570                                 if cfg!(feature = "fuzztarget") {
571                                         return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
572                                 } else {
573                                         panic!("RNG is bad???");
574                                 }
575                         },
576                         hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
577                 }
578                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
579                         node_id: their_network_key,
580                         msg: res,
581                 });
582                 Ok(())
583         }
584
585         /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
586         /// more information.
587         pub fn list_channels(&self) -> Vec<ChannelDetails> {
588                 let channel_state = self.channel_state.lock().unwrap();
589                 let mut res = Vec::with_capacity(channel_state.by_id.len());
590                 for (channel_id, channel) in channel_state.by_id.iter() {
591                         res.push(ChannelDetails {
592                                 channel_id: (*channel_id).clone(),
593                                 short_channel_id: channel.get_short_channel_id(),
594                                 remote_network_id: channel.get_their_node_id(),
595                                 channel_value_satoshis: channel.get_value_satoshis(),
596                                 user_id: channel.get_user_id(),
597                         });
598                 }
599                 res
600         }
601
602         /// Gets the list of usable channels, in random order. Useful as an argument to
603         /// Router::get_route to ensure non-announced channels are used.
604         pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
605                 let channel_state = self.channel_state.lock().unwrap();
606                 let mut res = Vec::with_capacity(channel_state.by_id.len());
607                 for (channel_id, channel) in channel_state.by_id.iter() {
608                         // Note we use is_live here instead of usable which leads to somewhat confused
609                         // internal/external nomenclature, but that's ok cause that's probably what the user
610                         // really wanted anyway.
611                         if channel.is_live() {
612                                 res.push(ChannelDetails {
613                                         channel_id: (*channel_id).clone(),
614                                         short_channel_id: channel.get_short_channel_id(),
615                                         remote_network_id: channel.get_their_node_id(),
616                                         channel_value_satoshis: channel.get_value_satoshis(),
617                                         user_id: channel.get_user_id(),
618                                 });
619                         }
620                 }
621                 res
622         }
623
624         /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
625         /// will be accepted on the given channel, and after additional timeout/the closing of all
626         /// pending HTLCs, the channel will be closed on chain.
627         ///
628         /// May generate a SendShutdown message event on success, which should be relayed.
629         pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
630                 let _ = self.total_consistency_lock.read().unwrap();
631
632                 let (mut failed_htlcs, chan_option) = {
633                         let mut channel_state_lock = self.channel_state.lock().unwrap();
634                         let channel_state = channel_state_lock.borrow_parts();
635                         match channel_state.by_id.entry(channel_id.clone()) {
636                                 hash_map::Entry::Occupied(mut chan_entry) => {
637                                         let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
638                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
639                                                 node_id: chan_entry.get().get_their_node_id(),
640                                                 msg: shutdown_msg
641                                         });
642                                         if chan_entry.get().is_shutdown() {
643                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
644                                                         channel_state.short_to_id.remove(&short_id);
645                                                 }
646                                                 (failed_htlcs, Some(chan_entry.remove_entry().1))
647                                         } else { (failed_htlcs, None) }
648                                 },
649                                 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
650                         }
651                 };
652                 for htlc_source in failed_htlcs.drain(..) {
653                         // unknown_next_peer...I dunno who that is anymore....
654                         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() });
655                 }
656                 let chan_update = if let Some(chan) = chan_option {
657                         if let Ok(update) = self.get_channel_update(&chan) {
658                                 Some(update)
659                         } else { None }
660                 } else { None };
661
662                 if let Some(update) = chan_update {
663                         let mut channel_state = self.channel_state.lock().unwrap();
664                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
665                                 msg: update
666                         });
667                 }
668
669                 Ok(())
670         }
671
672         #[inline]
673         fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
674                 let (local_txn, mut failed_htlcs) = shutdown_res;
675                 for htlc_source in failed_htlcs.drain(..) {
676                         // unknown_next_peer...I dunno who that is anymore....
677                         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() });
678                 }
679                 for tx in local_txn {
680                         self.tx_broadcaster.broadcast_transaction(&tx);
681                 }
682                 //TODO: We need to have a way where outbound HTLC claims can result in us claiming the
683                 //now-on-chain HTLC output for ourselves (and, thereafter, passing the HTLC backwards).
684                 //TODO: We need to handle monitoring of pending offered HTLCs which just hit the chain and
685                 //may be claimed, resulting in us claiming the inbound HTLCs (and back-failing after
686                 //timeouts are hit and our claims confirm).
687                 //TODO: In any case, we need to make sure we remove any pending htlc tracking (via
688                 //fail_backwards or claim_funds) eventually for all HTLCs that were in the channel
689         }
690
691         /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
692         /// the chain and rejecting new HTLCs on the given channel.
693         pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
694                 let _ = self.total_consistency_lock.read().unwrap();
695
696                 let mut chan = {
697                         let mut channel_state_lock = self.channel_state.lock().unwrap();
698                         let channel_state = channel_state_lock.borrow_parts();
699                         if let Some(chan) = channel_state.by_id.remove(channel_id) {
700                                 if let Some(short_id) = chan.get_short_channel_id() {
701                                         channel_state.short_to_id.remove(&short_id);
702                                 }
703                                 chan
704                         } else {
705                                 return;
706                         }
707                 };
708                 self.finish_force_close_channel(chan.force_shutdown());
709                 if let Ok(update) = self.get_channel_update(&chan) {
710                         let mut channel_state = self.channel_state.lock().unwrap();
711                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
712                                 msg: update
713                         });
714                 }
715         }
716
717         /// Force close all channels, immediately broadcasting the latest local commitment transaction
718         /// for each to the chain and rejecting new HTLCs on each.
719         pub fn force_close_all_channels(&self) {
720                 for chan in self.list_channels() {
721                         self.force_close_channel(&chan.channel_id);
722                 }
723         }
724
725         #[inline]
726         fn gen_rho_mu_from_shared_secret(shared_secret: &[u8]) -> ([u8; 32], [u8; 32]) {
727                 assert_eq!(shared_secret.len(), 32);
728                 ({
729                         let mut hmac = Hmac::new(Sha256::new(), &[0x72, 0x68, 0x6f]); // rho
730                         hmac.input(&shared_secret[..]);
731                         let mut res = [0; 32];
732                         hmac.raw_result(&mut res);
733                         res
734                 },
735                 {
736                         let mut hmac = Hmac::new(Sha256::new(), &[0x6d, 0x75]); // mu
737                         hmac.input(&shared_secret[..]);
738                         let mut res = [0; 32];
739                         hmac.raw_result(&mut res);
740                         res
741                 })
742         }
743
744         #[inline]
745         fn gen_um_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
746                 assert_eq!(shared_secret.len(), 32);
747                 let mut hmac = Hmac::new(Sha256::new(), &[0x75, 0x6d]); // um
748                 hmac.input(&shared_secret[..]);
749                 let mut res = [0; 32];
750                 hmac.raw_result(&mut res);
751                 res
752         }
753
754         #[inline]
755         fn gen_ammag_from_shared_secret(shared_secret: &[u8]) -> [u8; 32] {
756                 assert_eq!(shared_secret.len(), 32);
757                 let mut hmac = Hmac::new(Sha256::new(), &[0x61, 0x6d, 0x6d, 0x61, 0x67]); // ammag
758                 hmac.input(&shared_secret[..]);
759                 let mut res = [0; 32];
760                 hmac.raw_result(&mut res);
761                 res
762         }
763
764         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
765         #[inline]
766         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> {
767                 let mut blinded_priv = session_priv.clone();
768                 let mut blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
769
770                 for hop in route.hops.iter() {
771                         let shared_secret = SharedSecret::new(secp_ctx, &hop.pubkey, &blinded_priv);
772
773                         let mut sha = Sha256::new();
774                         sha.input(&blinded_pub.serialize()[..]);
775                         sha.input(&shared_secret[..]);
776                         let mut blinding_factor = [0u8; 32];
777                         sha.result(&mut blinding_factor);
778
779                         let ephemeral_pubkey = blinded_pub;
780
781                         blinded_priv.mul_assign(secp_ctx, &SecretKey::from_slice(secp_ctx, &blinding_factor)?)?;
782                         blinded_pub = PublicKey::from_secret_key(secp_ctx, &blinded_priv);
783
784                         callback(shared_secret, blinding_factor, ephemeral_pubkey, hop);
785                 }
786
787                 Ok(())
788         }
789
790         // can only fail if an intermediary hop has an invalid public key or session_priv is invalid
791         fn construct_onion_keys<T: secp256k1::Signing>(secp_ctx: &Secp256k1<T>, route: &Route, session_priv: &SecretKey) -> Result<Vec<OnionKeys>, secp256k1::Error> {
792                 let mut res = Vec::with_capacity(route.hops.len());
793
794                 Self::construct_onion_keys_callback(secp_ctx, route, session_priv, |shared_secret, _blinding_factor, ephemeral_pubkey, _| {
795                         let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret[..]);
796
797                         res.push(OnionKeys {
798                                 #[cfg(test)]
799                                 shared_secret,
800                                 #[cfg(test)]
801                                 blinding_factor: _blinding_factor,
802                                 ephemeral_pubkey,
803                                 rho,
804                                 mu,
805                         });
806                 })?;
807
808                 Ok(res)
809         }
810
811         /// returns the hop data, as well as the first-hop value_msat and CLTV value we should send.
812         fn build_onion_payloads(route: &Route, starting_htlc_offset: u32) -> Result<(Vec<msgs::OnionHopData>, u64, u32), APIError> {
813                 let mut cur_value_msat = 0u64;
814                 let mut cur_cltv = starting_htlc_offset;
815                 let mut last_short_channel_id = 0;
816                 let mut res: Vec<msgs::OnionHopData> = Vec::with_capacity(route.hops.len());
817                 internal_traits::test_no_dealloc::<msgs::OnionHopData>(None);
818                 unsafe { res.set_len(route.hops.len()); }
819
820                 for (idx, hop) in route.hops.iter().enumerate().rev() {
821                         // First hop gets special values so that it can check, on receipt, that everything is
822                         // exactly as it should be (and the next hop isn't trying to probe to find out if we're
823                         // the intended recipient).
824                         let value_msat = if cur_value_msat == 0 { hop.fee_msat } else { cur_value_msat };
825                         let cltv = if cur_cltv == starting_htlc_offset { hop.cltv_expiry_delta + starting_htlc_offset } else { cur_cltv };
826                         res[idx] = msgs::OnionHopData {
827                                 realm: 0,
828                                 data: msgs::OnionRealm0HopData {
829                                         short_channel_id: last_short_channel_id,
830                                         amt_to_forward: value_msat,
831                                         outgoing_cltv_value: cltv,
832                                 },
833                                 hmac: [0; 32],
834                         };
835                         cur_value_msat += hop.fee_msat;
836                         if cur_value_msat >= 21000000 * 100000000 * 1000 {
837                                 return Err(APIError::RouteError{err: "Channel fees overflowed?!"});
838                         }
839                         cur_cltv += hop.cltv_expiry_delta as u32;
840                         if cur_cltv >= 500000000 {
841                                 return Err(APIError::RouteError{err: "Channel CLTV overflowed?!"});
842                         }
843                         last_short_channel_id = hop.short_channel_id;
844                 }
845                 Ok((res, cur_value_msat, cur_cltv))
846         }
847
848         #[inline]
849         fn shift_arr_right(arr: &mut [u8; 20*65]) {
850                 unsafe {
851                         ptr::copy(arr[0..].as_ptr(), arr[65..].as_mut_ptr(), 19*65);
852                 }
853                 for i in 0..65 {
854                         arr[i] = 0;
855                 }
856         }
857
858         #[inline]
859         fn xor_bufs(dst: &mut[u8], src: &[u8]) {
860                 assert_eq!(dst.len(), src.len());
861
862                 for i in 0..dst.len() {
863                         dst[i] ^= src[i];
864                 }
865         }
866
867         const ZERO:[u8; 21*65] = [0; 21*65];
868         fn construct_onion_packet(mut payloads: Vec<msgs::OnionHopData>, onion_keys: Vec<OnionKeys>, associated_data: &[u8; 32]) -> msgs::OnionPacket {
869                 let mut buf = Vec::with_capacity(21*65);
870                 buf.resize(21*65, 0);
871
872                 let filler = {
873                         let iters = payloads.len() - 1;
874                         let end_len = iters * 65;
875                         let mut res = Vec::with_capacity(end_len);
876                         res.resize(end_len, 0);
877
878                         for (i, keys) in onion_keys.iter().enumerate() {
879                                 if i == payloads.len() - 1 { continue; }
880                                 let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
881                                 chacha.process(&ChannelManager::ZERO, &mut buf); // We don't have a seek function :(
882                                 ChannelManager::xor_bufs(&mut res[0..(i + 1)*65], &buf[(20 - i)*65..21*65]);
883                         }
884                         res
885                 };
886
887                 let mut packet_data = [0; 20*65];
888                 let mut hmac_res = [0; 32];
889
890                 for (i, (payload, keys)) in payloads.iter_mut().zip(onion_keys.iter()).rev().enumerate() {
891                         ChannelManager::shift_arr_right(&mut packet_data);
892                         payload.hmac = hmac_res;
893                         packet_data[0..65].copy_from_slice(&payload.encode()[..]);
894
895                         let mut chacha = ChaCha20::new(&keys.rho, &[0u8; 8]);
896                         chacha.process(&packet_data, &mut buf[0..20*65]);
897                         packet_data[..].copy_from_slice(&buf[0..20*65]);
898
899                         if i == 0 {
900                                 packet_data[20*65 - filler.len()..20*65].copy_from_slice(&filler[..]);
901                         }
902
903                         let mut hmac = Hmac::new(Sha256::new(), &keys.mu);
904                         hmac.input(&packet_data);
905                         hmac.input(&associated_data[..]);
906                         hmac.raw_result(&mut hmac_res);
907                 }
908
909                 msgs::OnionPacket{
910                         version: 0,
911                         public_key: Ok(onion_keys.first().unwrap().ephemeral_pubkey),
912                         hop_data: packet_data,
913                         hmac: hmac_res,
914                 }
915         }
916
917         /// Encrypts a failure packet. raw_packet can either be a
918         /// msgs::DecodedOnionErrorPacket.encode() result or a msgs::OnionErrorPacket.data element.
919         fn encrypt_failure_packet(shared_secret: &[u8], raw_packet: &[u8]) -> msgs::OnionErrorPacket {
920                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret);
921
922                 let mut packet_crypted = Vec::with_capacity(raw_packet.len());
923                 packet_crypted.resize(raw_packet.len(), 0);
924                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
925                 chacha.process(&raw_packet, &mut packet_crypted[..]);
926                 msgs::OnionErrorPacket {
927                         data: packet_crypted,
928                 }
929         }
930
931         fn build_failure_packet(shared_secret: &[u8], failure_type: u16, failure_data: &[u8]) -> msgs::DecodedOnionErrorPacket {
932                 assert_eq!(shared_secret.len(), 32);
933                 assert!(failure_data.len() <= 256 - 2);
934
935                 let um = ChannelManager::gen_um_from_shared_secret(&shared_secret);
936
937                 let failuremsg = {
938                         let mut res = Vec::with_capacity(2 + failure_data.len());
939                         res.push(((failure_type >> 8) & 0xff) as u8);
940                         res.push(((failure_type >> 0) & 0xff) as u8);
941                         res.extend_from_slice(&failure_data[..]);
942                         res
943                 };
944                 let pad = {
945                         let mut res = Vec::with_capacity(256 - 2 - failure_data.len());
946                         res.resize(256 - 2 - failure_data.len(), 0);
947                         res
948                 };
949                 let mut packet = msgs::DecodedOnionErrorPacket {
950                         hmac: [0; 32],
951                         failuremsg: failuremsg,
952                         pad: pad,
953                 };
954
955                 let mut hmac = Hmac::new(Sha256::new(), &um);
956                 hmac.input(&packet.encode()[32..]);
957                 hmac.raw_result(&mut packet.hmac);
958
959                 packet
960         }
961
962         #[inline]
963         fn build_first_hop_failure_packet(shared_secret: &[u8], failure_type: u16, failure_data: &[u8]) -> msgs::OnionErrorPacket {
964                 let failure_packet = ChannelManager::build_failure_packet(shared_secret, failure_type, failure_data);
965                 ChannelManager::encrypt_failure_packet(shared_secret, &failure_packet.encode()[..])
966         }
967
968         fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder>) {
969                 macro_rules! get_onion_hash {
970                         () => {
971                                 {
972                                         let mut sha = Sha256::new();
973                                         sha.input(&msg.onion_routing_packet.hop_data);
974                                         let mut onion_hash = [0; 32];
975                                         sha.result(&mut onion_hash);
976                                         onion_hash
977                                 }
978                         }
979                 }
980
981                 if let Err(_) = msg.onion_routing_packet.public_key {
982                         log_info!(self, "Failed to accept/forward incoming HTLC with invalid ephemeral pubkey");
983                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
984                                 channel_id: msg.channel_id,
985                                 htlc_id: msg.htlc_id,
986                                 sha256_of_onion: get_onion_hash!(),
987                                 failure_code: 0x8000 | 0x4000 | 6,
988                         })), self.channel_state.lock().unwrap());
989                 }
990
991                 let shared_secret = {
992                         let mut arr = [0; 32];
993                         arr.copy_from_slice(&SharedSecret::new(&self.secp_ctx, &msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
994                         arr
995                 };
996                 let (rho, mu) = ChannelManager::gen_rho_mu_from_shared_secret(&shared_secret);
997
998                 let mut channel_state = None;
999                 macro_rules! return_err {
1000                         ($msg: expr, $err_code: expr, $data: expr) => {
1001                                 {
1002                                         log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
1003                                         if channel_state.is_none() {
1004                                                 channel_state = Some(self.channel_state.lock().unwrap());
1005                                         }
1006                                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
1007                                                 channel_id: msg.channel_id,
1008                                                 htlc_id: msg.htlc_id,
1009                                                 reason: ChannelManager::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
1010                                         })), channel_state.unwrap());
1011                                 }
1012                         }
1013                 }
1014
1015                 if msg.onion_routing_packet.version != 0 {
1016                         //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
1017                         //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
1018                         //the hash doesn't really serve any purpuse - in the case of hashing all data, the
1019                         //receiving node would have to brute force to figure out which version was put in the
1020                         //packet by the node that send us the message, in the case of hashing the hop_data, the
1021                         //node knows the HMAC matched, so they already know what is there...
1022                         return_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4, &get_onion_hash!());
1023                 }
1024
1025                 let mut hmac = Hmac::new(Sha256::new(), &mu);
1026                 hmac.input(&msg.onion_routing_packet.hop_data);
1027                 hmac.input(&msg.payment_hash);
1028                 if hmac.result() != MacResult::new(&msg.onion_routing_packet.hmac) {
1029                         return_err!("HMAC Check failed", 0x8000 | 0x4000 | 5, &get_onion_hash!());
1030                 }
1031
1032                 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
1033                 let next_hop_data = {
1034                         let mut decoded = [0; 65];
1035                         chacha.process(&msg.onion_routing_packet.hop_data[0..65], &mut decoded);
1036                         match msgs::OnionHopData::read(&mut Cursor::new(&decoded[..])) {
1037                                 Err(err) => {
1038                                         let error_code = match err {
1039                                                 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
1040                                                 _ => 0x2000 | 2, // Should never happen
1041                                         };
1042                                         return_err!("Unable to decode our hop data", error_code, &[0;0]);
1043                                 },
1044                                 Ok(msg) => msg
1045                         }
1046                 };
1047
1048                 let pending_forward_info = if next_hop_data.hmac == [0; 32] {
1049                                 // OUR PAYMENT!
1050                                 // final_expiry_too_soon
1051                                 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS) as u64 {
1052                                         return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
1053                                 }
1054                                 // final_incorrect_htlc_amount
1055                                 if next_hop_data.data.amt_to_forward > msg.amount_msat {
1056                                         return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
1057                                 }
1058                                 // final_incorrect_cltv_expiry
1059                                 if next_hop_data.data.outgoing_cltv_value != msg.cltv_expiry {
1060                                         return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
1061                                 }
1062
1063                                 // Note that we could obviously respond immediately with an update_fulfill_htlc
1064                                 // message, however that would leak that we are the recipient of this payment, so
1065                                 // instead we stay symmetric with the forwarding case, only responding (after a
1066                                 // delay) once they've send us a commitment_signed!
1067
1068                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
1069                                         onion_packet: None,
1070                                         payment_hash: msg.payment_hash.clone(),
1071                                         short_channel_id: 0,
1072                                         incoming_shared_secret: shared_secret,
1073                                         amt_to_forward: next_hop_data.data.amt_to_forward,
1074                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1075                                 })
1076                         } else {
1077                                 let mut new_packet_data = [0; 20*65];
1078                                 chacha.process(&msg.onion_routing_packet.hop_data[65..], &mut new_packet_data[0..19*65]);
1079                                 chacha.process(&ChannelManager::ZERO[0..65], &mut new_packet_data[19*65..]);
1080
1081                                 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
1082
1083                                 let blinding_factor = {
1084                                         let mut sha = Sha256::new();
1085                                         sha.input(&new_pubkey.serialize()[..]);
1086                                         sha.input(&shared_secret);
1087                                         let mut res = [0u8; 32];
1088                                         sha.result(&mut res);
1089                                         match SecretKey::from_slice(&self.secp_ctx, &res) {
1090                                                 Err(_) => {
1091                                                         return_err!("Blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
1092                                                 },
1093                                                 Ok(key) => key
1094                                         }
1095                                 };
1096
1097                                 if let Err(_) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor) {
1098                                         return_err!("New blinding factor is an invalid private key", 0x8000 | 0x4000 | 6, &get_onion_hash!());
1099                                 }
1100
1101                                 let outgoing_packet = msgs::OnionPacket {
1102                                         version: 0,
1103                                         public_key: Ok(new_pubkey),
1104                                         hop_data: new_packet_data,
1105                                         hmac: next_hop_data.hmac.clone(),
1106                                 };
1107
1108                                 PendingHTLCStatus::Forward(PendingForwardHTLCInfo {
1109                                         onion_packet: Some(outgoing_packet),
1110                                         payment_hash: msg.payment_hash.clone(),
1111                                         short_channel_id: next_hop_data.data.short_channel_id,
1112                                         incoming_shared_secret: shared_secret,
1113                                         amt_to_forward: next_hop_data.data.amt_to_forward,
1114                                         outgoing_cltv_value: next_hop_data.data.outgoing_cltv_value,
1115                                 })
1116                         };
1117
1118                 channel_state = Some(self.channel_state.lock().unwrap());
1119                 if let &PendingHTLCStatus::Forward(PendingForwardHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1120                         if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1121                                 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1122                                 let forwarding_id = match id_option {
1123                                         None => { // unknown_next_peer
1124                                                 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1125                                         },
1126                                         Some(id) => id.clone(),
1127                                 };
1128                                 if let Some((err, code, chan_update)) = loop {
1129                                         let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1130
1131                                         // Note that we could technically not return an error yet here and just hope
1132                                         // that the connection is reestablished or monitor updated by the time we get
1133                                         // around to doing the actual forward, but better to fail early if we can and
1134                                         // hopefully an attacker trying to path-trace payments cannot make this occur
1135                                         // on a small/per-node/per-channel scale.
1136                                         if !chan.is_live() { // channel_disabled
1137                                                 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1138                                         }
1139                                         if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
1140                                                 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1141                                         }
1142                                         let fee = amt_to_forward.checked_mul(chan.get_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) });
1143                                         if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1144                                                 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())));
1145                                         }
1146                                         if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1147                                                 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())));
1148                                         }
1149                                         let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1150                                         // We want to have at least HTLC_FAIL_TIMEOUT_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1151                                         if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + HTLC_FAIL_TIMEOUT_BLOCKS as u32 { // expiry_too_soon
1152                                                 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1153                                         }
1154                                         if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1155                                                 break Some(("CLTV expiry is too far in the future", 21, None));
1156                                         }
1157                                         break None;
1158                                 }
1159                                 {
1160                                         let mut res = Vec::with_capacity(8 + 128);
1161                                         if code == 0x1000 | 11 || code == 0x1000 | 12 {
1162                                                 res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1163                                         }
1164                                         else if code == 0x1000 | 13 {
1165                                                 res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1166                                         }
1167                                         if let Some(chan_update) = chan_update {
1168                                                 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1169                                         }
1170                                         return_err!(err, code, &res[..]);
1171                                 }
1172                         }
1173                 }
1174
1175                 (pending_forward_info, channel_state.unwrap())
1176         }
1177
1178         /// only fails if the channel does not yet have an assigned short_id
1179         /// May be called with channel_state already locked!
1180         fn get_channel_update(&self, chan: &Channel) -> Result<msgs::ChannelUpdate, HandleError> {
1181                 let short_channel_id = match chan.get_short_channel_id() {
1182                         None => return Err(HandleError{err: "Channel not yet established", action: None}),
1183                         Some(id) => id,
1184                 };
1185
1186                 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1187
1188                 let unsigned = msgs::UnsignedChannelUpdate {
1189                         chain_hash: self.genesis_hash,
1190                         short_channel_id: short_channel_id,
1191                         timestamp: chan.get_channel_update_count(),
1192                         flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1193                         cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1194                         htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1195                         fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1196                         fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1197                         excess_data: Vec::new(),
1198                 };
1199
1200                 let msg_hash = Sha256dHash::from_data(&unsigned.encode()[..]);
1201                 let sig = self.secp_ctx.sign(&Message::from_slice(&msg_hash[..]).unwrap(), &self.our_network_key);
1202
1203                 Ok(msgs::ChannelUpdate {
1204                         signature: sig,
1205                         contents: unsigned
1206                 })
1207         }
1208
1209         /// Sends a payment along a given route.
1210         ///
1211         /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1212         /// fields for more info.
1213         ///
1214         /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1215         /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1216         /// next hop knows the preimage to payment_hash they can claim an additional amount as
1217         /// specified in the last hop in the route! Thus, you should probably do your own
1218         /// payment_preimage tracking (which you should already be doing as they represent "proof of
1219         /// payment") and prevent double-sends yourself.
1220         ///
1221         /// May generate a SendHTLCs message event on success, which should be relayed.
1222         ///
1223         /// Raises APIError::RoutError when invalid route or forward parameter
1224         /// (cltv_delta, fee, node public key) is specified.
1225         /// Raises APIError::ChannelUnavailable if the next-hop channel is not available for updates
1226         /// (including due to previous monitor update failure or new permanent monitor update failure).
1227         /// Raised APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1228         /// relevant updates.
1229         ///
1230         /// In case of APIError::RouteError/APIError::ChannelUnavailable, the payment send has failed
1231         /// and you may wish to retry via a different route immediately.
1232         /// In case of APIError::MonitorUpdateFailed, the commitment update has been irrevocably
1233         /// committed on our end and we're just waiting for a monitor update to send it. Do NOT retry
1234         /// the payment via a different route unless you intend to pay twice!
1235         pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), APIError> {
1236                 if route.hops.len() < 1 || route.hops.len() > 20 {
1237                         return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1238                 }
1239                 let our_node_id = self.get_our_node_id();
1240                 for (idx, hop) in route.hops.iter().enumerate() {
1241                         if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1242                                 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1243                         }
1244                 }
1245
1246                 let session_priv = self.keys_manager.get_session_key();
1247
1248                 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1249
1250                 let onion_keys = secp_call!(ChannelManager::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1251                                 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1252                 let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height)?;
1253                 let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &payment_hash);
1254
1255                 let _ = self.total_consistency_lock.read().unwrap();
1256
1257                 let err: Result<(), _> = loop {
1258                         let mut channel_lock = self.channel_state.lock().unwrap();
1259
1260                         let id = match channel_lock.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1261                                 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1262                                 Some(id) => id.clone(),
1263                         };
1264
1265                         let channel_state = channel_lock.borrow_parts();
1266                         if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1267                                 match {
1268                                         if chan.get().get_their_node_id() != route.hops.first().unwrap().pubkey {
1269                                                 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1270                                         }
1271                                         if !chan.get().is_live() {
1272                                                 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!"});
1273                                         }
1274                                         break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1275                                                 route: route.clone(),
1276                                                 session_priv: session_priv.clone(),
1277                                                 first_hop_htlc_msat: htlc_msat,
1278                                         }, onion_packet), channel_state, chan)
1279                                 } {
1280                                         Some((update_add, commitment_signed, chan_monitor)) => {
1281                                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1282                                                         maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst);
1283                                                         // Note that MonitorUpdateFailed here indicates (per function docs)
1284                                                         // that we will resent the commitment update once we unfree monitor
1285                                                         // updating, so we have to take special care that we don't return
1286                                                         // something else in case we will resend later!
1287                                                         return Err(APIError::MonitorUpdateFailed);
1288                                                 }
1289
1290                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1291                                                         node_id: route.hops.first().unwrap().pubkey,
1292                                                         updates: msgs::CommitmentUpdate {
1293                                                                 update_add_htlcs: vec![update_add],
1294                                                                 update_fulfill_htlcs: Vec::new(),
1295                                                                 update_fail_htlcs: Vec::new(),
1296                                                                 update_fail_malformed_htlcs: Vec::new(),
1297                                                                 update_fee: None,
1298                                                                 commitment_signed,
1299                                                         },
1300                                                 });
1301                                         },
1302                                         None => {},
1303                                 }
1304                         } else { unreachable!(); }
1305                         return Ok(());
1306                 };
1307
1308                 match handle_error!(self, err, route.hops.first().unwrap().pubkey) {
1309                         Ok(_) => unreachable!(),
1310                         Err(e) => {
1311                                 if let Some(msgs::ErrorAction::IgnoreError) = e.action {
1312                                 } else {
1313                                         log_error!(self, "Got bad keys: {}!", e.err);
1314                                         let mut channel_state = self.channel_state.lock().unwrap();
1315                                         channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1316                                                 node_id: route.hops.first().unwrap().pubkey,
1317                                                 action: e.action,
1318                                         });
1319                                 }
1320                                 Err(APIError::ChannelUnavailable { err: e.err })
1321                         },
1322                 }
1323         }
1324
1325         /// Call this upon creation of a funding transaction for the given channel.
1326         ///
1327         /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
1328         /// or your counterparty can steal your funds!
1329         ///
1330         /// Panics if a funding transaction has already been provided for this channel.
1331         ///
1332         /// May panic if the funding_txo is duplicative with some other channel (note that this should
1333         /// be trivially prevented by using unique funding transaction keys per-channel).
1334         pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1335                 let _ = self.total_consistency_lock.read().unwrap();
1336
1337                 let (chan, msg, chan_monitor) = {
1338                         let (res, chan) = {
1339                                 let mut channel_state = self.channel_state.lock().unwrap();
1340                                 match channel_state.by_id.remove(temporary_channel_id) {
1341                                         Some(mut chan) => {
1342                                                 (chan.get_outbound_funding_created(funding_txo)
1343                                                         .map_err(|e| if let ChannelError::Close(msg) = e {
1344                                                                 MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(), None)
1345                                                         } else { unreachable!(); })
1346                                                 , chan)
1347                                         },
1348                                         None => return
1349                                 }
1350                         };
1351                         match handle_error!(self, res, chan.get_their_node_id()) {
1352                                 Ok(funding_msg) => {
1353                                         (chan, funding_msg.0, funding_msg.1)
1354                                 },
1355                                 Err(e) => {
1356                                         log_error!(self, "Got bad signatures: {}!", e.err);
1357                                         let mut channel_state = self.channel_state.lock().unwrap();
1358                                         channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
1359                                                 node_id: chan.get_their_node_id(),
1360                                                 action: e.action,
1361                                         });
1362                                         return;
1363                                 },
1364                         }
1365                 };
1366                 // Because we have exclusive ownership of the channel here we can release the channel_state
1367                 // lock before add_update_monitor
1368                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1369                         unimplemented!();
1370                 }
1371
1372                 let mut channel_state = self.channel_state.lock().unwrap();
1373                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1374                         node_id: chan.get_their_node_id(),
1375                         msg: msg,
1376                 });
1377                 match channel_state.by_id.entry(chan.channel_id()) {
1378                         hash_map::Entry::Occupied(_) => {
1379                                 panic!("Generated duplicate funding txid?");
1380                         },
1381                         hash_map::Entry::Vacant(e) => {
1382                                 e.insert(chan);
1383                         }
1384                 }
1385         }
1386
1387         fn get_announcement_sigs(&self, chan: &Channel) -> Option<msgs::AnnouncementSignatures> {
1388                 if !chan.should_announce() { return None }
1389
1390                 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1391                         Ok(res) => res,
1392                         Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1393                 };
1394                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
1395                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1396
1397                 Some(msgs::AnnouncementSignatures {
1398                         channel_id: chan.channel_id(),
1399                         short_channel_id: chan.get_short_channel_id().unwrap(),
1400                         node_signature: our_node_sig,
1401                         bitcoin_signature: our_bitcoin_sig,
1402                 })
1403         }
1404
1405         /// Processes HTLCs which are pending waiting on random forward delay.
1406         ///
1407         /// Should only really ever be called in response to an PendingHTLCsForwardable event.
1408         /// Will likely generate further events.
1409         pub fn process_pending_htlc_forwards(&self) {
1410                 let _ = self.total_consistency_lock.read().unwrap();
1411
1412                 let mut new_events = Vec::new();
1413                 let mut failed_forwards = Vec::new();
1414                 {
1415                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1416                         let channel_state = channel_state_lock.borrow_parts();
1417
1418                         if cfg!(not(feature = "fuzztarget")) && Instant::now() < *channel_state.next_forward {
1419                                 return;
1420                         }
1421
1422                         for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1423                                 if short_chan_id != 0 {
1424                                         let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1425                                                 Some(chan_id) => chan_id.clone(),
1426                                                 None => {
1427                                                         failed_forwards.reserve(pending_forwards.len());
1428                                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1429                                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1430                                                                         short_channel_id: prev_short_channel_id,
1431                                                                         htlc_id: prev_htlc_id,
1432                                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1433                                                                 });
1434                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1435                                                         }
1436                                                         continue;
1437                                                 }
1438                                         };
1439                                         let forward_chan = &mut channel_state.by_id.get_mut(&forward_chan_id).unwrap();
1440
1441                                         let mut add_htlc_msgs = Vec::new();
1442                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1443                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1444                                                         short_channel_id: prev_short_channel_id,
1445                                                         htlc_id: prev_htlc_id,
1446                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1447                                                 });
1448                                                 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()) {
1449                                                         Err(_e) => {
1450                                                                 let chan_update = self.get_channel_update(forward_chan).unwrap();
1451                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1452                                                                 continue;
1453                                                         },
1454                                                         Ok(update_add) => {
1455                                                                 match update_add {
1456                                                                         Some(msg) => { add_htlc_msgs.push(msg); },
1457                                                                         None => {
1458                                                                                 // Nothing to do here...we're waiting on a remote
1459                                                                                 // revoke_and_ack before we can add anymore HTLCs. The Channel
1460                                                                                 // will automatically handle building the update_add_htlc and
1461                                                                                 // commitment_signed messages when we can.
1462                                                                                 // TODO: Do some kind of timer to set the channel as !is_live()
1463                                                                                 // as we don't really want others relying on us relaying through
1464                                                                                 // this channel currently :/.
1465                                                                         }
1466                                                                 }
1467                                                         }
1468                                                 }
1469                                         }
1470
1471                                         if !add_htlc_msgs.is_empty() {
1472                                                 let (commitment_msg, monitor) = match forward_chan.send_commitment() {
1473                                                         Ok(res) => res,
1474                                                         Err(e) => {
1475                                                                 if let ChannelError::Ignore(_) = e {
1476                                                                         panic!("Stated return value requirements in send_commitment() were not met");
1477                                                                 }
1478                                                                 //TODO: Handle...this is bad!
1479                                                                 continue;
1480                                                         },
1481                                                 };
1482                                                 if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1483                                                         unimplemented!();
1484                                                 }
1485                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1486                                                         node_id: forward_chan.get_their_node_id(),
1487                                                         updates: msgs::CommitmentUpdate {
1488                                                                 update_add_htlcs: add_htlc_msgs,
1489                                                                 update_fulfill_htlcs: Vec::new(),
1490                                                                 update_fail_htlcs: Vec::new(),
1491                                                                 update_fail_malformed_htlcs: Vec::new(),
1492                                                                 update_fee: None,
1493                                                                 commitment_signed: commitment_msg,
1494                                                         },
1495                                                 });
1496                                         }
1497                                 } else {
1498                                         for HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info } in pending_forwards.drain(..) {
1499                                                 let prev_hop_data = HTLCPreviousHopData {
1500                                                         short_channel_id: prev_short_channel_id,
1501                                                         htlc_id: prev_htlc_id,
1502                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1503                                                 };
1504                                                 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1505                                                         hash_map::Entry::Occupied(mut entry) => entry.get_mut().push(prev_hop_data),
1506                                                         hash_map::Entry::Vacant(entry) => { entry.insert(vec![prev_hop_data]); },
1507                                                 };
1508                                                 new_events.push(events::Event::PaymentReceived {
1509                                                         payment_hash: forward_info.payment_hash,
1510                                                         amt: forward_info.amt_to_forward,
1511                                                 });
1512                                         }
1513                                 }
1514                         }
1515                 }
1516
1517                 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1518                         match update {
1519                                 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1520                                 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() }),
1521                         };
1522                 }
1523
1524                 if new_events.is_empty() { return }
1525                 let mut events = self.pending_events.lock().unwrap();
1526                 events.append(&mut new_events);
1527         }
1528
1529         /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect after a PaymentReceived event.
1530         pub fn fail_htlc_backwards(&self, payment_hash: &[u8; 32], reason: PaymentFailReason) -> bool {
1531                 let _ = self.total_consistency_lock.read().unwrap();
1532
1533                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1534                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1535                 if let Some(mut sources) = removed_source {
1536                         for htlc_with_hash in sources.drain(..) {
1537                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1538                                 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() });
1539                         }
1540                         true
1541                 } else { false }
1542         }
1543
1544         /// Fails an HTLC backwards to the sender of it to us.
1545         /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1546         /// There are several callsites that do stupid things like loop over a list of payment_hashes
1547         /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1548         /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1549         /// still-available channels.
1550         fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_hash: &[u8; 32], onion_error: HTLCFailReason) {
1551                 match source {
1552                         HTLCSource::OutboundRoute { .. } => {
1553                                 mem::drop(channel_state_lock);
1554                                 if let &HTLCFailReason::ErrorPacket { ref err } = &onion_error {
1555                                         let (channel_update, payment_retryable) = self.process_onion_failure(&source, err.data.clone());
1556                                         if let Some(update) = channel_update {
1557                                                 self.channel_state.lock().unwrap().pending_msg_events.push(
1558                                                         events::MessageSendEvent::PaymentFailureNetworkUpdate {
1559                                                                 update,
1560                                                         }
1561                                                 );
1562                                         }
1563                                         self.pending_events.lock().unwrap().push(events::Event::PaymentFailed {
1564                                                 payment_hash: payment_hash.clone(),
1565                                                 rejected_by_dest: !payment_retryable,
1566                                         });
1567                                 } else {
1568                                         panic!("should have onion error packet here");
1569                                 }
1570                         },
1571                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1572                                 let err_packet = match onion_error {
1573                                         HTLCFailReason::Reason { failure_code, data } => {
1574                                                 let packet = ChannelManager::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1575                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1576                                         },
1577                                         HTLCFailReason::ErrorPacket { err } => {
1578                                                 ChannelManager::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1579                                         }
1580                                 };
1581
1582                                 let channel_state = channel_state_lock.borrow_parts();
1583
1584                                 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1585                                         Some(chan_id) => chan_id.clone(),
1586                                         None => return
1587                                 };
1588
1589                                 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1590                                 match chan.get_update_fail_htlc_and_commit(htlc_id, err_packet) {
1591                                         Ok(Some((msg, commitment_msg, chan_monitor))) => {
1592                                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1593                                                         unimplemented!();
1594                                                 }
1595                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1596                                                         node_id: chan.get_their_node_id(),
1597                                                         updates: msgs::CommitmentUpdate {
1598                                                                 update_add_htlcs: Vec::new(),
1599                                                                 update_fulfill_htlcs: Vec::new(),
1600                                                                 update_fail_htlcs: vec![msg],
1601                                                                 update_fail_malformed_htlcs: Vec::new(),
1602                                                                 update_fee: None,
1603                                                                 commitment_signed: commitment_msg,
1604                                                         },
1605                                                 });
1606                                         },
1607                                         Ok(None) => {},
1608                                         Err(_e) => {
1609                                                 //TODO: Do something with e?
1610                                                 return;
1611                                         },
1612                                 }
1613                         },
1614                 }
1615         }
1616
1617         /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1618         /// generating message events for the net layer to claim the payment, if possible. Thus, you
1619         /// should probably kick the net layer to go send messages if this returns true!
1620         ///
1621         /// May panic if called except in response to a PaymentReceived event.
1622         pub fn claim_funds(&self, payment_preimage: [u8; 32]) -> bool {
1623                 let mut sha = Sha256::new();
1624                 sha.input(&payment_preimage);
1625                 let mut payment_hash = [0; 32];
1626                 sha.result(&mut payment_hash);
1627
1628                 let _ = self.total_consistency_lock.read().unwrap();
1629
1630                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1631                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1632                 if let Some(mut sources) = removed_source {
1633                         for htlc_with_hash in sources.drain(..) {
1634                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1635                                 self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1636                         }
1637                         true
1638                 } else { false }
1639         }
1640         fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder>, source: HTLCSource, payment_preimage: [u8; 32]) {
1641                 match source {
1642                         HTLCSource::OutboundRoute { .. } => {
1643                                 mem::drop(channel_state_lock);
1644                                 let mut pending_events = self.pending_events.lock().unwrap();
1645                                 pending_events.push(events::Event::PaymentSent {
1646                                         payment_preimage
1647                                 });
1648                         },
1649                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1650                                 //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1651                                 let channel_state = channel_state_lock.borrow_parts();
1652
1653                                 let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1654                                         Some(chan_id) => chan_id.clone(),
1655                                         None => {
1656                                                 // TODO: There is probably a channel manager somewhere that needs to
1657                                                 // learn the preimage as the channel already hit the chain and that's
1658                                                 // why its missing.
1659                                                 return
1660                                         }
1661                                 };
1662
1663                                 let chan = channel_state.by_id.get_mut(&chan_id).unwrap();
1664                                 match chan.get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1665                                         Ok((msgs, monitor_option)) => {
1666                                                 if let Some(chan_monitor) = monitor_option {
1667                                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1668                                                                 unimplemented!();// but def dont push the event...
1669                                                         }
1670                                                 }
1671                                                 if let Some((msg, commitment_signed)) = msgs {
1672                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1673                                                                 node_id: chan.get_their_node_id(),
1674                                                                 updates: msgs::CommitmentUpdate {
1675                                                                         update_add_htlcs: Vec::new(),
1676                                                                         update_fulfill_htlcs: vec![msg],
1677                                                                         update_fail_htlcs: Vec::new(),
1678                                                                         update_fail_malformed_htlcs: Vec::new(),
1679                                                                         update_fee: None,
1680                                                                         commitment_signed,
1681                                                                 }
1682                                                         });
1683                                                 }
1684                                         },
1685                                         Err(_e) => {
1686                                                 // TODO: There is probably a channel manager somewhere that needs to
1687                                                 // learn the preimage as the channel may be about to hit the chain.
1688                                                 //TODO: Do something with e?
1689                                                 return
1690                                         },
1691                                 }
1692                         },
1693                 }
1694         }
1695
1696         /// Gets the node_id held by this ChannelManager
1697         pub fn get_our_node_id(&self) -> PublicKey {
1698                 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1699         }
1700
1701         /// Used to restore channels to normal operation after a
1702         /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1703         /// operation.
1704         pub fn test_restore_channel_monitor(&self) {
1705                 let mut close_results = Vec::new();
1706                 let mut htlc_forwards = Vec::new();
1707                 let mut htlc_failures = Vec::new();
1708                 let _ = self.total_consistency_lock.read().unwrap();
1709
1710                 {
1711                         let mut channel_lock = self.channel_state.lock().unwrap();
1712                         let channel_state = channel_lock.borrow_parts();
1713                         let short_to_id = channel_state.short_to_id;
1714                         let pending_msg_events = channel_state.pending_msg_events;
1715                         channel_state.by_id.retain(|_, channel| {
1716                                 if channel.is_awaiting_monitor_update() {
1717                                         let chan_monitor = channel.channel_monitor();
1718                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1719                                                 match e {
1720                                                         ChannelMonitorUpdateErr::PermanentFailure => {
1721                                                                 // TODO: There may be some pending HTLCs that we intended to fail
1722                                                                 // backwards when a monitor update failed. We should make sure
1723                                                                 // knowledge of those gets moved into the appropriate in-memory
1724                                                                 // ChannelMonitor and they get failed backwards once we get
1725                                                                 // on-chain confirmations.
1726                                                                 // Note I think #198 addresses this, so once its merged a test
1727                                                                 // should be written.
1728                                                                 if let Some(short_id) = channel.get_short_channel_id() {
1729                                                                         short_to_id.remove(&short_id);
1730                                                                 }
1731                                                                 close_results.push(channel.force_shutdown());
1732                                                                 if let Ok(update) = self.get_channel_update(&channel) {
1733                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1734                                                                                 msg: update
1735                                                                         });
1736                                                                 }
1737                                                                 false
1738                                                         },
1739                                                         ChannelMonitorUpdateErr::TemporaryFailure => true,
1740                                                 }
1741                                         } else {
1742                                                 let (raa, commitment_update, order, pending_forwards, mut pending_failures) = channel.monitor_updating_restored();
1743                                                 if !pending_forwards.is_empty() {
1744                                                         htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1745                                                 }
1746                                                 htlc_failures.append(&mut pending_failures);
1747
1748                                                 macro_rules! handle_cs { () => {
1749                                                         if let Some(update) = commitment_update {
1750                                                                 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1751                                                                         node_id: channel.get_their_node_id(),
1752                                                                         updates: update,
1753                                                                 });
1754                                                         }
1755                                                 } }
1756                                                 macro_rules! handle_raa { () => {
1757                                                         if let Some(revoke_and_ack) = raa {
1758                                                                 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1759                                                                         node_id: channel.get_their_node_id(),
1760                                                                         msg: revoke_and_ack,
1761                                                                 });
1762                                                         }
1763                                                 } }
1764                                                 match order {
1765                                                         RAACommitmentOrder::CommitmentFirst => {
1766                                                                 handle_cs!();
1767                                                                 handle_raa!();
1768                                                         },
1769                                                         RAACommitmentOrder::RevokeAndACKFirst => {
1770                                                                 handle_raa!();
1771                                                                 handle_cs!();
1772                                                         },
1773                                                 }
1774                                                 true
1775                                         }
1776                                 } else { true }
1777                         });
1778                 }
1779
1780                 for failure in htlc_failures.drain(..) {
1781                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1782                 }
1783                 self.forward_htlcs(&mut htlc_forwards[..]);
1784
1785                 for res in close_results.drain(..) {
1786                         self.finish_force_close_channel(res);
1787                 }
1788         }
1789
1790         fn internal_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1791                 if msg.chain_hash != self.genesis_hash {
1792                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1793                 }
1794
1795                 let channel = Channel::new_from_req(&*self.fee_estimator, &self.keys_manager, their_node_id.clone(), msg, 0, Arc::clone(&self.logger), &self.default_configuration)
1796                         .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1797                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1798                 let channel_state = channel_state_lock.borrow_parts();
1799                 match channel_state.by_id.entry(channel.channel_id()) {
1800                         hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1801                         hash_map::Entry::Vacant(entry) => {
1802                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1803                                         node_id: their_node_id.clone(),
1804                                         msg: channel.get_accept_channel(),
1805                                 });
1806                                 entry.insert(channel);
1807                         }
1808                 }
1809                 Ok(())
1810         }
1811
1812         fn internal_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1813                 let (value, output_script, user_id) = {
1814                         let mut channel_lock = self.channel_state.lock().unwrap();
1815                         let channel_state = channel_lock.borrow_parts();
1816                         match channel_state.by_id.entry(msg.temporary_channel_id) {
1817                                 hash_map::Entry::Occupied(mut chan) => {
1818                                         if chan.get().get_their_node_id() != *their_node_id {
1819                                                 //TODO: see issue #153, need a consistent behavior on obnoxious behavior from random node
1820                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1821                                         }
1822                                         try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration), channel_state, chan);
1823                                         (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
1824                                 },
1825                                 //TODO: same as above
1826                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1827                         }
1828                 };
1829                 let mut pending_events = self.pending_events.lock().unwrap();
1830                 pending_events.push(events::Event::FundingGenerationReady {
1831                         temporary_channel_id: msg.temporary_channel_id,
1832                         channel_value_satoshis: value,
1833                         output_script: output_script,
1834                         user_channel_id: user_id,
1835                 });
1836                 Ok(())
1837         }
1838
1839         fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1840                 let ((funding_msg, monitor_update), chan) = {
1841                         let mut channel_lock = self.channel_state.lock().unwrap();
1842                         let channel_state = channel_lock.borrow_parts();
1843                         match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1844                                 hash_map::Entry::Occupied(mut chan) => {
1845                                         if chan.get().get_their_node_id() != *their_node_id {
1846                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1847                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1848                                         }
1849                                         (try_chan_entry!(self, chan.get_mut().funding_created(msg), channel_state, chan), chan.remove())
1850                                 },
1851                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1852                         }
1853                 };
1854                 // Because we have exclusive ownership of the channel here we can release the channel_state
1855                 // lock before add_update_monitor
1856                 if let Err(_e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1857                         unimplemented!();
1858                 }
1859                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1860                 let channel_state = channel_state_lock.borrow_parts();
1861                 match channel_state.by_id.entry(funding_msg.channel_id) {
1862                         hash_map::Entry::Occupied(_) => {
1863                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
1864                         },
1865                         hash_map::Entry::Vacant(e) => {
1866                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
1867                                         node_id: their_node_id.clone(),
1868                                         msg: funding_msg,
1869                                 });
1870                                 e.insert(chan);
1871                         }
1872                 }
1873                 Ok(())
1874         }
1875
1876         fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
1877                 let (funding_txo, user_id) = {
1878                         let mut channel_lock = self.channel_state.lock().unwrap();
1879                         let channel_state = channel_lock.borrow_parts();
1880                         match channel_state.by_id.entry(msg.channel_id) {
1881                                 hash_map::Entry::Occupied(mut chan) => {
1882                                         if chan.get().get_their_node_id() != *their_node_id {
1883                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1884                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1885                                         }
1886                                         let chan_monitor = try_chan_entry!(self, chan.get_mut().funding_signed(&msg), channel_state, chan);
1887                                         if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1888                                                 unimplemented!();
1889                                         }
1890                                         (chan.get().get_funding_txo().unwrap(), chan.get().get_user_id())
1891                                 },
1892                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1893                         }
1894                 };
1895                 let mut pending_events = self.pending_events.lock().unwrap();
1896                 pending_events.push(events::Event::FundingBroadcastSafe {
1897                         funding_txo: funding_txo,
1898                         user_channel_id: user_id,
1899                 });
1900                 Ok(())
1901         }
1902
1903         fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
1904                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1905                 let channel_state = channel_state_lock.borrow_parts();
1906                 match channel_state.by_id.entry(msg.channel_id) {
1907                         hash_map::Entry::Occupied(mut chan) => {
1908                                 if chan.get().get_their_node_id() != *their_node_id {
1909                                         //TODO: here and below MsgHandleErrInternal, #153 case
1910                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1911                                 }
1912                                 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
1913                                 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
1914                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1915                                                 node_id: their_node_id.clone(),
1916                                                 msg: announcement_sigs,
1917                                         });
1918                                 }
1919                                 Ok(())
1920                         },
1921                         hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1922                 }
1923         }
1924
1925         fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
1926                 let (mut dropped_htlcs, chan_option) = {
1927                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1928                         let channel_state = channel_state_lock.borrow_parts();
1929
1930                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1931                                 hash_map::Entry::Occupied(mut chan_entry) => {
1932                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1933                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1934                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1935                                         }
1936                                         let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg), channel_state, chan_entry);
1937                                         if let Some(msg) = shutdown {
1938                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
1939                                                         node_id: their_node_id.clone(),
1940                                                         msg,
1941                                                 });
1942                                         }
1943                                         if let Some(msg) = closing_signed {
1944                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1945                                                         node_id: their_node_id.clone(),
1946                                                         msg,
1947                                                 });
1948                                         }
1949                                         if chan_entry.get().is_shutdown() {
1950                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1951                                                         channel_state.short_to_id.remove(&short_id);
1952                                                 }
1953                                                 (dropped_htlcs, Some(chan_entry.remove_entry().1))
1954                                         } else { (dropped_htlcs, None) }
1955                                 },
1956                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
1957                         }
1958                 };
1959                 for htlc_source in dropped_htlcs.drain(..) {
1960                         // unknown_next_peer...I dunno who that is anymore....
1961                         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() });
1962                 }
1963                 if let Some(chan) = chan_option {
1964                         if let Ok(update) = self.get_channel_update(&chan) {
1965                                 let mut channel_state = self.channel_state.lock().unwrap();
1966                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1967                                         msg: update
1968                                 });
1969                         }
1970                 }
1971                 Ok(())
1972         }
1973
1974         fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
1975                 let (tx, chan_option) = {
1976                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1977                         let channel_state = channel_state_lock.borrow_parts();
1978                         match channel_state.by_id.entry(msg.channel_id.clone()) {
1979                                 hash_map::Entry::Occupied(mut chan_entry) => {
1980                                         if chan_entry.get().get_their_node_id() != *their_node_id {
1981                                                 //TODO: here and below MsgHandleErrInternal, #153 case
1982                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
1983                                         }
1984                                         let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg), channel_state, chan_entry);
1985                                         if let Some(msg) = closing_signed {
1986                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
1987                                                         node_id: their_node_id.clone(),
1988                                                         msg,
1989                                                 });
1990                                         }
1991                                         if tx.is_some() {
1992                                                 // We're done with this channel, we've got a signed closing transaction and
1993                                                 // will send the closing_signed back to the remote peer upon return. This
1994                                                 // also implies there are no pending HTLCs left on the channel, so we can
1995                                                 // fully delete it from tracking (the channel monitor is still around to
1996                                                 // watch for old state broadcasts)!
1997                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
1998                                                         channel_state.short_to_id.remove(&short_id);
1999                                                 }
2000                                                 (tx, Some(chan_entry.remove_entry().1))
2001                                         } else { (tx, None) }
2002                                 },
2003                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2004                         }
2005                 };
2006                 if let Some(broadcast_tx) = tx {
2007                         self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2008                 }
2009                 if let Some(chan) = chan_option {
2010                         if let Ok(update) = self.get_channel_update(&chan) {
2011                                 let mut channel_state = self.channel_state.lock().unwrap();
2012                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2013                                         msg: update
2014                                 });
2015                         }
2016                 }
2017                 Ok(())
2018         }
2019
2020         fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2021                 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2022                 //determine the state of the payment based on our response/if we forward anything/the time
2023                 //we take to respond. We should take care to avoid allowing such an attack.
2024                 //
2025                 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2026                 //us repeatedly garbled in different ways, and compare our error messages, which are
2027                 //encrypted with the same key. Its not immediately obvious how to usefully exploit that,
2028                 //but we should prevent it anyway.
2029
2030                 let (mut pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2031                 let channel_state = channel_state_lock.borrow_parts();
2032
2033                 match channel_state.by_id.entry(msg.channel_id) {
2034                         hash_map::Entry::Occupied(mut chan) => {
2035                                 if chan.get().get_their_node_id() != *their_node_id {
2036                                         //TODO: here MsgHandleErrInternal, #153 case
2037                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2038                                 }
2039                                 if !chan.get().is_usable() {
2040                                         // If the update_add is completely bogus, the call will Err and we will close,
2041                                         // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2042                                         // want to reject the new HTLC and fail it backwards instead of forwarding.
2043                                         if let PendingHTLCStatus::Forward(PendingForwardHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
2044                                                 let chan_update = self.get_channel_update(chan.get());
2045                                                 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2046                                                         channel_id: msg.channel_id,
2047                                                         htlc_id: msg.htlc_id,
2048                                                         reason: if let Ok(update) = chan_update {
2049                                                                 ChannelManager::build_first_hop_failure_packet(&incoming_shared_secret, 0x1000|20, &update.encode_with_len()[..])
2050                                                         } else {
2051                                                                 // This can only happen if the channel isn't in the fully-funded
2052                                                                 // state yet, implying our counterparty is trying to route payments
2053                                                                 // over the channel back to themselves (cause no one else should
2054                                                                 // know the short_id is a lightning channel yet). We should have no
2055                                                                 // problem just calling this unknown_next_peer
2056                                                                 ChannelManager::build_first_hop_failure_packet(&incoming_shared_secret, 0x4000|10, &[])
2057                                                         },
2058                                                 }));
2059                                         }
2060                                 }
2061                                 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info), channel_state, chan);
2062                         },
2063                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2064                 }
2065                 Ok(())
2066         }
2067
2068         fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2069                 let mut channel_lock = self.channel_state.lock().unwrap();
2070                 let htlc_source = {
2071                         let channel_state = channel_lock.borrow_parts();
2072                         match channel_state.by_id.entry(msg.channel_id) {
2073                                 hash_map::Entry::Occupied(mut chan) => {
2074                                         if chan.get().get_their_node_id() != *their_node_id {
2075                                                 //TODO: here and below MsgHandleErrInternal, #153 case
2076                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2077                                         }
2078                                         try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2079                                 },
2080                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2081                         }
2082                 };
2083                 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2084                 Ok(())
2085         }
2086
2087         // Process failure we got back from upstream on a payment we sent. Returns update and a boolean
2088         // indicating that the payment itself failed
2089         fn process_onion_failure(&self, htlc_source: &HTLCSource, mut packet_decrypted: Vec<u8>) -> (Option<msgs::HTLCFailChannelUpdate>, bool) {
2090                 if let &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } = htlc_source {
2091                         macro_rules! onion_failure_log {
2092                                 ( $error_code_textual: expr, $error_code: expr, $reported_name: expr, $reported_value: expr ) => {
2093                                         log_trace!(self, "{}({:#x}) {}({})", $error_code_textual, $error_code, $reported_name, $reported_value);
2094                                 };
2095                                 ( $error_code_textual: expr, $error_code: expr ) => {
2096                                         log_trace!(self, "{}({})", $error_code_textual, $error_code);
2097                                 };
2098                         }
2099
2100                         const BADONION: u16 = 0x8000;
2101                         const PERM: u16 = 0x4000;
2102                         const UPDATE: u16 = 0x1000;
2103
2104                         let mut res = None;
2105                         let mut htlc_msat = *first_hop_htlc_msat;
2106
2107                         // Handle packed channel/node updates for passing back for the route handler
2108                         Self::construct_onion_keys_callback(&self.secp_ctx, route, session_priv, |shared_secret, _, _, route_hop| {
2109                                 if res.is_some() { return; }
2110
2111                                 let incoming_htlc_msat = htlc_msat;
2112                                 let amt_to_forward = htlc_msat - route_hop.fee_msat;
2113                                 htlc_msat = amt_to_forward;
2114
2115                                 let ammag = ChannelManager::gen_ammag_from_shared_secret(&shared_secret[..]);
2116
2117                                 let mut decryption_tmp = Vec::with_capacity(packet_decrypted.len());
2118                                 decryption_tmp.resize(packet_decrypted.len(), 0);
2119                                 let mut chacha = ChaCha20::new(&ammag, &[0u8; 8]);
2120                                 chacha.process(&packet_decrypted, &mut decryption_tmp[..]);
2121                                 packet_decrypted = decryption_tmp;
2122
2123                                 let is_from_final_node = route.hops.last().unwrap().pubkey == route_hop.pubkey;
2124
2125                                 if let Ok(err_packet) = msgs::DecodedOnionErrorPacket::read(&mut Cursor::new(&packet_decrypted)) {
2126                                         let um = ChannelManager::gen_um_from_shared_secret(&shared_secret[..]);
2127                                         let mut hmac = Hmac::new(Sha256::new(), &um);
2128                                         hmac.input(&err_packet.encode()[32..]);
2129                                         let mut calc_tag = [0u8; 32];
2130                                         hmac.raw_result(&mut calc_tag);
2131
2132                                         if crypto::util::fixed_time_eq(&calc_tag, &err_packet.hmac) {
2133                                                 if err_packet.failuremsg.len() < 2 {
2134                                                         // Useless packet that we can't use but it passed HMAC, so it
2135                                                         // definitely came from the peer in question
2136                                                         res = Some((None, !is_from_final_node));
2137                                                 } else {
2138                                                         let error_code = byte_utils::slice_to_be16(&err_packet.failuremsg[0..2]);
2139
2140                                                         match error_code & 0xff {
2141                                                                 1|2|3 => {
2142                                                                         // either from an intermediate or final node
2143                                                                         //   invalid_realm(PERM|1),
2144                                                                         //   temporary_node_failure(NODE|2)
2145                                                                         //   permanent_node_failure(PERM|NODE|2)
2146                                                                         //   required_node_feature_mssing(PERM|NODE|3)
2147                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2148                                                                                 node_id: route_hop.pubkey,
2149                                                                                 is_permanent: error_code & PERM == PERM,
2150                                                                         }), !(error_code & PERM == PERM && is_from_final_node)));
2151                                                                         // node returning invalid_realm is removed from network_map,
2152                                                                         // although NODE flag is not set, TODO: or remove channel only?
2153                                                                         // retry payment when removed node is not a final node
2154                                                                         return;
2155                                                                 },
2156                                                                 _ => {}
2157                                                         }
2158
2159                                                         if is_from_final_node {
2160                                                                 let payment_retryable = match error_code {
2161                                                                         c if c == PERM|15 => false, // unknown_payment_hash
2162                                                                         c if c == PERM|16 => false, // incorrect_payment_amount
2163                                                                         17 => true, // final_expiry_too_soon
2164                                                                         18 if err_packet.failuremsg.len() == 6 => { // final_incorrect_cltv_expiry
2165                                                                                 let _reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
2166                                                                                 true
2167                                                                         },
2168                                                                         19 if err_packet.failuremsg.len() == 10 => { // final_incorrect_htlc_amount
2169                                                                                 let _reported_incoming_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2170                                                                                 true
2171                                                                         },
2172                                                                         _ => {
2173                                                                                 // A final node has sent us either an invalid code or an error_code that
2174                                                                                 // MUST be sent from the processing node, or the formmat of failuremsg
2175                                                                                 // does not coform to the spec.
2176                                                                                 // Remove it from the network map and don't may retry payment
2177                                                                                 res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2178                                                                                         node_id: route_hop.pubkey,
2179                                                                                         is_permanent: true,
2180                                                                                 }), false));
2181                                                                                 return;
2182                                                                         }
2183                                                                 };
2184                                                                 res = Some((None, payment_retryable));
2185                                                                 return;
2186                                                         }
2187
2188                                                         // now, error_code should be only from the intermediate nodes
2189                                                         match error_code {
2190                                                                 _c if error_code & PERM == PERM => {
2191                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::ChannelClosed {
2192                                                                                 short_channel_id: route_hop.short_channel_id,
2193                                                                                 is_permanent: true,
2194                                                                         }), false));
2195                                                                 },
2196                                                                 _c if error_code & UPDATE == UPDATE => {
2197                                                                         let offset = match error_code {
2198                                                                                 c if c == UPDATE|7  => 0, // temporary_channel_failure
2199                                                                                 c if c == UPDATE|11 => 8, // amount_below_minimum
2200                                                                                 c if c == UPDATE|12 => 8, // fee_insufficient
2201                                                                                 c if c == UPDATE|13 => 4, // incorrect_cltv_expiry
2202                                                                                 c if c == UPDATE|14 => 0, // expiry_too_soon
2203                                                                                 c if c == UPDATE|20 => 2, // channel_disabled
2204                                                                                 _ =>  {
2205                                                                                         // node sending unknown code
2206                                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2207                                                                                                 node_id: route_hop.pubkey,
2208                                                                                                 is_permanent: true,
2209                                                                                         }), false));
2210                                                                                         return;
2211                                                                                 }
2212                                                                         };
2213
2214                                                                         if err_packet.failuremsg.len() >= offset + 2 {
2215                                                                                 let update_len = byte_utils::slice_to_be16(&err_packet.failuremsg[offset+2..offset+4]) as usize;
2216                                                                                 if err_packet.failuremsg.len() >= offset + 4 + update_len {
2217                                                                                         if let Ok(chan_update) = msgs::ChannelUpdate::read(&mut Cursor::new(&err_packet.failuremsg[offset + 4..offset + 4 + update_len])) {
2218                                                                                                 // if channel_update should NOT have caused the failure:
2219                                                                                                 // MAY treat the channel_update as invalid.
2220                                                                                                 let is_chan_update_invalid = match error_code {
2221                                                                                                         c if c == UPDATE|7 => { // temporary_channel_failure
2222                                                                                                                 false
2223                                                                                                         },
2224                                                                                                         c if c == UPDATE|11 => { // amount_below_minimum
2225                                                                                                                 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2226                                                                                                                 onion_failure_log!("amount_below_minimum", UPDATE|11, "htlc_msat", reported_htlc_msat);
2227                                                                                                                 incoming_htlc_msat > chan_update.contents.htlc_minimum_msat
2228                                                                                                         },
2229                                                                                                         c if c == UPDATE|12 => { // fee_insufficient
2230                                                                                                                 let reported_htlc_msat = byte_utils::slice_to_be64(&err_packet.failuremsg[2..2+8]);
2231                                                                                                                 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) });
2232                                                                                                                 onion_failure_log!("fee_insufficient", UPDATE|12, "htlc_msat", reported_htlc_msat);
2233                                                                                                                 new_fee.is_none() || incoming_htlc_msat >= new_fee.unwrap() && incoming_htlc_msat >= amt_to_forward + new_fee.unwrap()
2234                                                                                                         }
2235                                                                                                         c if c == UPDATE|13 => { // incorrect_cltv_expiry
2236                                                                                                                 let reported_cltv_expiry = byte_utils::slice_to_be32(&err_packet.failuremsg[2..2+4]);
2237                                                                                                                 onion_failure_log!("incorrect_cltv_expiry", UPDATE|13, "cltv_expiry", reported_cltv_expiry);
2238                                                                                                                 route_hop.cltv_expiry_delta as u16 >= chan_update.contents.cltv_expiry_delta
2239                                                                                                         },
2240                                                                                                         c if c == UPDATE|20 => { // channel_disabled
2241                                                                                                                 let reported_flags = byte_utils::slice_to_be16(&err_packet.failuremsg[2..2+2]);
2242                                                                                                                 onion_failure_log!("channel_disabled", UPDATE|20, "flags", reported_flags);
2243                                                                                                                 chan_update.contents.flags & 0x01 == 0x01
2244                                                                                                         },
2245                                                                                                         c if c == UPDATE|21 => true, // expiry_too_far
2246                                                                                                         _ => { unreachable!(); },
2247                                                                                                 };
2248
2249                                                                                                 let msg = if is_chan_update_invalid { None } else {
2250                                                                                                         Some(msgs::HTLCFailChannelUpdate::ChannelUpdateMessage {
2251                                                                                                                 msg: chan_update,
2252                                                                                                         })
2253                                                                                                 };
2254                                                                                                 res = Some((msg, true));
2255                                                                                                 return;
2256                                                                                         }
2257                                                                                 }
2258                                                                         }
2259                                                                 },
2260                                                                 _c if error_code & BADONION == BADONION => {
2261                                                                         //TODO
2262                                                                 },
2263                                                                 14 => { // expiry_too_soon
2264                                                                         res = Some((None, true));
2265                                                                         return;
2266                                                                 }
2267                                                                 _ => {
2268                                                                         // node sending unknown code
2269                                                                         res = Some((Some(msgs::HTLCFailChannelUpdate::NodeFailure {
2270                                                                                 node_id: route_hop.pubkey,
2271                                                                                 is_permanent: true,
2272                                                                         }), false));
2273                                                                         return;
2274                                                                 }
2275                                                         }
2276                                                 }
2277                                         }
2278                                 }
2279                         }).expect("Route that we sent via spontaneously grew invalid keys in the middle of it?");
2280                         res.unwrap_or((None, true))
2281                 } else { ((None, true)) }
2282         }
2283
2284         fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2285                 let mut channel_lock = self.channel_state.lock().unwrap();
2286                 let channel_state = channel_lock.borrow_parts();
2287                 match channel_state.by_id.entry(msg.channel_id) {
2288                         hash_map::Entry::Occupied(mut chan) => {
2289                                 if chan.get().get_their_node_id() != *their_node_id {
2290                                         //TODO: here and below MsgHandleErrInternal, #153 case
2291                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2292                                 }
2293                                 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() }), channel_state, chan);
2294                         },
2295                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2296                 }
2297                 Ok(())
2298         }
2299
2300         fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2301                 let mut channel_lock = self.channel_state.lock().unwrap();
2302                 let channel_state = channel_lock.borrow_parts();
2303                 match channel_state.by_id.entry(msg.channel_id) {
2304                         hash_map::Entry::Occupied(mut chan) => {
2305                                 if chan.get().get_their_node_id() != *their_node_id {
2306                                         //TODO: here and below MsgHandleErrInternal, #153 case
2307                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2308                                 }
2309                                 if (msg.failure_code & 0x8000) == 0 {
2310                                         try_chan_entry!(self, Err(ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set")), channel_state, chan);
2311                                 }
2312                                 try_chan_entry!(self, chan.get_mut().update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() }), channel_state, chan);
2313                                 Ok(())
2314                         },
2315                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2316                 }
2317         }
2318
2319         fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2320                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2321                 let channel_state = channel_state_lock.borrow_parts();
2322                 match channel_state.by_id.entry(msg.channel_id) {
2323                         hash_map::Entry::Occupied(mut chan) => {
2324                                 if chan.get().get_their_node_id() != *their_node_id {
2325                                         //TODO: here and below MsgHandleErrInternal, #153 case
2326                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2327                                 }
2328                                 let (revoke_and_ack, commitment_signed, closing_signed, chan_monitor) =
2329                                         try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &*self.fee_estimator), channel_state, chan);
2330                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2331                                         return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, commitment_signed.is_some());
2332                                         //TODO: Rebroadcast closing_signed if present on monitor update restoration
2333                                 }
2334                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2335                                         node_id: their_node_id.clone(),
2336                                         msg: revoke_and_ack,
2337                                 });
2338                                 if let Some(msg) = commitment_signed {
2339                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2340                                                 node_id: their_node_id.clone(),
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: None,
2347                                                         commitment_signed: msg,
2348                                                 },
2349                                         });
2350                                 }
2351                                 if let Some(msg) = closing_signed {
2352                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2353                                                 node_id: their_node_id.clone(),
2354                                                 msg,
2355                                         });
2356                                 }
2357                                 Ok(())
2358                         },
2359                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2360                 }
2361         }
2362
2363         #[inline]
2364         fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingForwardHTLCInfo, u64)>)]) {
2365                 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2366                         let mut forward_event = None;
2367                         if !pending_forwards.is_empty() {
2368                                 let mut channel_state = self.channel_state.lock().unwrap();
2369                                 if channel_state.forward_htlcs.is_empty() {
2370                                         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));
2371                                         channel_state.next_forward = forward_event.unwrap();
2372                                 }
2373                                 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2374                                         match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2375                                                 hash_map::Entry::Occupied(mut entry) => {
2376                                                         entry.get_mut().push(HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info });
2377                                                 },
2378                                                 hash_map::Entry::Vacant(entry) => {
2379                                                         entry.insert(vec!(HTLCForwardInfo { prev_short_channel_id, prev_htlc_id, forward_info }));
2380                                                 }
2381                                         }
2382                                 }
2383                         }
2384                         match forward_event {
2385                                 Some(time) => {
2386                                         let mut pending_events = self.pending_events.lock().unwrap();
2387                                         pending_events.push(events::Event::PendingHTLCsForwardable {
2388                                                 time_forwardable: time
2389                                         });
2390                                 }
2391                                 None => {},
2392                         }
2393                 }
2394         }
2395
2396         fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2397                 let (pending_forwards, mut pending_failures, short_channel_id) = {
2398                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2399                         let channel_state = channel_state_lock.borrow_parts();
2400                         match channel_state.by_id.entry(msg.channel_id) {
2401                                 hash_map::Entry::Occupied(mut chan) => {
2402                                         if chan.get().get_their_node_id() != *their_node_id {
2403                                                 //TODO: here and below MsgHandleErrInternal, #153 case
2404                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2405                                         }
2406                                         let (commitment_update, pending_forwards, pending_failures, closing_signed, chan_monitor) =
2407                                                 try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &*self.fee_estimator), channel_state, chan);
2408                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2409                                                 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, pending_forwards, pending_failures);
2410                                         }
2411                                         if let Some(updates) = commitment_update {
2412                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2413                                                         node_id: their_node_id.clone(),
2414                                                         updates,
2415                                                 });
2416                                         }
2417                                         if let Some(msg) = closing_signed {
2418                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2419                                                         node_id: their_node_id.clone(),
2420                                                         msg,
2421                                                 });
2422                                         }
2423                                         (pending_forwards, pending_failures, chan.get().get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2424                                 },
2425                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2426                         }
2427                 };
2428                 for failure in pending_failures.drain(..) {
2429                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2430                 }
2431                 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2432
2433                 Ok(())
2434         }
2435
2436         fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2437                 let mut channel_lock = self.channel_state.lock().unwrap();
2438                 let channel_state = channel_lock.borrow_parts();
2439                 match channel_state.by_id.entry(msg.channel_id) {
2440                         hash_map::Entry::Occupied(mut chan) => {
2441                                 if chan.get().get_their_node_id() != *their_node_id {
2442                                         //TODO: here and below MsgHandleErrInternal, #153 case
2443                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2444                                 }
2445                                 try_chan_entry!(self, chan.get_mut().update_fee(&*self.fee_estimator, &msg), channel_state, chan);
2446                         },
2447                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2448                 }
2449                 Ok(())
2450         }
2451
2452         fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2453                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2454                 let channel_state = channel_state_lock.borrow_parts();
2455
2456                 match channel_state.by_id.entry(msg.channel_id) {
2457                         hash_map::Entry::Occupied(mut chan) => {
2458                                 if chan.get().get_their_node_id() != *their_node_id {
2459                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2460                                 }
2461                                 if !chan.get().is_usable() {
2462                                         return Err(MsgHandleErrInternal::from_no_close(HandleError{err: "Got an announcement_signatures before we were ready for it", action: Some(msgs::ErrorAction::IgnoreError)}));
2463                                 }
2464
2465                                 let our_node_id = self.get_our_node_id();
2466                                 let (announcement, our_bitcoin_sig) =
2467                                         try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
2468
2469                                 let were_node_one = announcement.node_id_1 == our_node_id;
2470                                 let msghash = Message::from_slice(&Sha256dHash::from_data(&announcement.encode()[..])[..]).unwrap();
2471                                 if self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }).is_err() ||
2472                                                 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }).is_err() {
2473                                         try_chan_entry!(self, Err(ChannelError::Close("Bad announcement_signatures node_signature")), channel_state, chan);
2474                                 }
2475
2476                                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2477
2478                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2479                                         msg: msgs::ChannelAnnouncement {
2480                                                 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2481                                                 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2482                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2483                                                 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2484                                                 contents: announcement,
2485                                         },
2486                                         update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
2487                                 });
2488                         },
2489                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2490                 }
2491                 Ok(())
2492         }
2493
2494         fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2495                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2496                 let channel_state = channel_state_lock.borrow_parts();
2497
2498                 match channel_state.by_id.entry(msg.channel_id) {
2499                         hash_map::Entry::Occupied(mut chan) => {
2500                                 if chan.get().get_their_node_id() != *their_node_id {
2501                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2502                                 }
2503                                 let (funding_locked, revoke_and_ack, commitment_update, channel_monitor, mut order, shutdown) =
2504                                         try_chan_entry!(self, chan.get_mut().channel_reestablish(msg), channel_state, chan);
2505                                 if let Some(monitor) = channel_monitor {
2506                                         if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
2507                                                 // channel_reestablish doesn't guarantee the order it returns is sensical
2508                                                 // for the messages it returns, but if we're setting what messages to
2509                                                 // re-transmit on monitor update success, we need to make sure it is sane.
2510                                                 if revoke_and_ack.is_none() {
2511                                                         order = RAACommitmentOrder::CommitmentFirst;
2512                                                 }
2513                                                 if commitment_update.is_none() {
2514                                                         order = RAACommitmentOrder::RevokeAndACKFirst;
2515                                                 }
2516                                                 return_monitor_err!(self, e, channel_state, chan, order);
2517                                                 //TODO: Resend the funding_locked if needed once we get the monitor running again
2518                                         }
2519                                 }
2520                                 if let Some(msg) = funding_locked {
2521                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2522                                                 node_id: their_node_id.clone(),
2523                                                 msg
2524                                         });
2525                                 }
2526                                 macro_rules! send_raa { () => {
2527                                         if let Some(msg) = revoke_and_ack {
2528                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2529                                                         node_id: their_node_id.clone(),
2530                                                         msg
2531                                                 });
2532                                         }
2533                                 } }
2534                                 macro_rules! send_cu { () => {
2535                                         if let Some(updates) = commitment_update {
2536                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2537                                                         node_id: their_node_id.clone(),
2538                                                         updates
2539                                                 });
2540                                         }
2541                                 } }
2542                                 match order {
2543                                         RAACommitmentOrder::RevokeAndACKFirst => {
2544                                                 send_raa!();
2545                                                 send_cu!();
2546                                         },
2547                                         RAACommitmentOrder::CommitmentFirst => {
2548                                                 send_cu!();
2549                                                 send_raa!();
2550                                         },
2551                                 }
2552                                 if let Some(msg) = shutdown {
2553                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2554                                                 node_id: their_node_id.clone(),
2555                                                 msg,
2556                                         });
2557                                 }
2558                                 Ok(())
2559                         },
2560                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2561                 }
2562         }
2563
2564         /// Begin Update fee process. Allowed only on an outbound channel.
2565         /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2566         /// PeerManager::process_events afterwards.
2567         /// Note: This API is likely to change!
2568         #[doc(hidden)]
2569         pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2570                 let _ = self.total_consistency_lock.read().unwrap();
2571                 let their_node_id;
2572                 let err: Result<(), _> = loop {
2573                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2574                         let channel_state = channel_state_lock.borrow_parts();
2575
2576                         match channel_state.by_id.entry(channel_id) {
2577                                 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2578                                 hash_map::Entry::Occupied(mut chan) => {
2579                                         if !chan.get().is_outbound() {
2580                                                 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2581                                         }
2582                                         if chan.get().is_awaiting_monitor_update() {
2583                                                 return Err(APIError::MonitorUpdateFailed);
2584                                         }
2585                                         if !chan.get().is_live() {
2586                                                 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2587                                         }
2588                                         their_node_id = chan.get().get_their_node_id();
2589                                         if let Some((update_fee, commitment_signed, chan_monitor)) =
2590                                                         break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw), channel_state, chan)
2591                                         {
2592                                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2593                                                         unimplemented!();
2594                                                 }
2595                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2596                                                         node_id: chan.get().get_their_node_id(),
2597                                                         updates: msgs::CommitmentUpdate {
2598                                                                 update_add_htlcs: Vec::new(),
2599                                                                 update_fulfill_htlcs: Vec::new(),
2600                                                                 update_fail_htlcs: Vec::new(),
2601                                                                 update_fail_malformed_htlcs: Vec::new(),
2602                                                                 update_fee: Some(update_fee),
2603                                                                 commitment_signed,
2604                                                         },
2605                                                 });
2606                                         }
2607                                 },
2608                         }
2609                         return Ok(())
2610                 };
2611
2612                 match handle_error!(self, err, their_node_id) {
2613                         Ok(_) => unreachable!(),
2614                         Err(e) => {
2615                                 if let Some(msgs::ErrorAction::IgnoreError) = e.action {
2616                                 } else {
2617                                         log_error!(self, "Got bad keys: {}!", e.err);
2618                                         let mut channel_state = self.channel_state.lock().unwrap();
2619                                         channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError {
2620                                                 node_id: their_node_id,
2621                                                 action: e.action,
2622                                         });
2623                                 }
2624                                 Err(APIError::APIMisuseError { err: e.err })
2625                         },
2626                 }
2627         }
2628 }
2629
2630 impl events::MessageSendEventsProvider for ChannelManager {
2631         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2632                 let mut ret = Vec::new();
2633                 let mut channel_state = self.channel_state.lock().unwrap();
2634                 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2635                 ret
2636         }
2637 }
2638
2639 impl events::EventsProvider for ChannelManager {
2640         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2641                 let mut ret = Vec::new();
2642                 let mut pending_events = self.pending_events.lock().unwrap();
2643                 mem::swap(&mut ret, &mut *pending_events);
2644                 ret
2645         }
2646 }
2647
2648 impl ChainListener for ChannelManager {
2649         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2650                 let _ = self.total_consistency_lock.read().unwrap();
2651                 let mut failed_channels = Vec::new();
2652                 {
2653                         let mut channel_lock = self.channel_state.lock().unwrap();
2654                         let channel_state = channel_lock.borrow_parts();
2655                         let short_to_id = channel_state.short_to_id;
2656                         let pending_msg_events = channel_state.pending_msg_events;
2657                         channel_state.by_id.retain(|_, channel| {
2658                                 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2659                                 if let Ok(Some(funding_locked)) = chan_res {
2660                                         pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2661                                                 node_id: channel.get_their_node_id(),
2662                                                 msg: funding_locked,
2663                                         });
2664                                         if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2665                                                 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2666                                                         node_id: channel.get_their_node_id(),
2667                                                         msg: announcement_sigs,
2668                                                 });
2669                                         }
2670                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2671                                 } else if let Err(e) = chan_res {
2672                                         pending_msg_events.push(events::MessageSendEvent::HandleError {
2673                                                 node_id: channel.get_their_node_id(),
2674                                                 action: Some(msgs::ErrorAction::SendErrorMessage { msg: e }),
2675                                         });
2676                                         return false;
2677                                 }
2678                                 if let Some(funding_txo) = channel.get_funding_txo() {
2679                                         for tx in txn_matched {
2680                                                 for inp in tx.input.iter() {
2681                                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2682                                                                 if let Some(short_id) = channel.get_short_channel_id() {
2683                                                                         short_to_id.remove(&short_id);
2684                                                                 }
2685                                                                 // It looks like our counterparty went on-chain. We go ahead and
2686                                                                 // broadcast our latest local state as well here, just in case its
2687                                                                 // some kind of SPV attack, though we expect these to be dropped.
2688                                                                 failed_channels.push(channel.force_shutdown());
2689                                                                 if let Ok(update) = self.get_channel_update(&channel) {
2690                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2691                                                                                 msg: update
2692                                                                         });
2693                                                                 }
2694                                                                 return false;
2695                                                         }
2696                                                 }
2697                                         }
2698                                 }
2699                                 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2700                                         if let Some(short_id) = channel.get_short_channel_id() {
2701                                                 short_to_id.remove(&short_id);
2702                                         }
2703                                         failed_channels.push(channel.force_shutdown());
2704                                         // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2705                                         // the latest local tx for us, so we should skip that here (it doesn't really
2706                                         // hurt anything, but does make tests a bit simpler).
2707                                         failed_channels.last_mut().unwrap().0 = Vec::new();
2708                                         if let Ok(update) = self.get_channel_update(&channel) {
2709                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2710                                                         msg: update
2711                                                 });
2712                                         }
2713                                         return false;
2714                                 }
2715                                 true
2716                         });
2717                 }
2718                 for failure in failed_channels.drain(..) {
2719                         self.finish_force_close_channel(failure);
2720                 }
2721                 self.latest_block_height.store(height as usize, Ordering::Release);
2722                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2723         }
2724
2725         /// We force-close the channel without letting our counterparty participate in the shutdown
2726         fn block_disconnected(&self, header: &BlockHeader) {
2727                 let _ = self.total_consistency_lock.read().unwrap();
2728                 let mut failed_channels = Vec::new();
2729                 {
2730                         let mut channel_lock = self.channel_state.lock().unwrap();
2731                         let channel_state = channel_lock.borrow_parts();
2732                         let short_to_id = channel_state.short_to_id;
2733                         let pending_msg_events = channel_state.pending_msg_events;
2734                         channel_state.by_id.retain(|_,  v| {
2735                                 if v.block_disconnected(header) {
2736                                         if let Some(short_id) = v.get_short_channel_id() {
2737                                                 short_to_id.remove(&short_id);
2738                                         }
2739                                         failed_channels.push(v.force_shutdown());
2740                                         if let Ok(update) = self.get_channel_update(&v) {
2741                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2742                                                         msg: update
2743                                                 });
2744                                         }
2745                                         false
2746                                 } else {
2747                                         true
2748                                 }
2749                         });
2750                 }
2751                 for failure in failed_channels.drain(..) {
2752                         self.finish_force_close_channel(failure);
2753                 }
2754                 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2755                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2756         }
2757 }
2758
2759 impl ChannelMessageHandler for ChannelManager {
2760         //TODO: Handle errors and close channel (or so)
2761         fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result<(), HandleError> {
2762                 let _ = self.total_consistency_lock.read().unwrap();
2763                 handle_error!(self, self.internal_open_channel(their_node_id, msg), their_node_id)
2764         }
2765
2766         fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &msgs::AcceptChannel) -> Result<(), HandleError> {
2767                 let _ = self.total_consistency_lock.read().unwrap();
2768                 handle_error!(self, self.internal_accept_channel(their_node_id, msg), their_node_id)
2769         }
2770
2771         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), HandleError> {
2772                 let _ = self.total_consistency_lock.read().unwrap();
2773                 handle_error!(self, self.internal_funding_created(their_node_id, msg), their_node_id)
2774         }
2775
2776         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), HandleError> {
2777                 let _ = self.total_consistency_lock.read().unwrap();
2778                 handle_error!(self, self.internal_funding_signed(their_node_id, msg), their_node_id)
2779         }
2780
2781         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), HandleError> {
2782                 let _ = self.total_consistency_lock.read().unwrap();
2783                 handle_error!(self, self.internal_funding_locked(their_node_id, msg), their_node_id)
2784         }
2785
2786         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), HandleError> {
2787                 let _ = self.total_consistency_lock.read().unwrap();
2788                 handle_error!(self, self.internal_shutdown(their_node_id, msg), their_node_id)
2789         }
2790
2791         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), HandleError> {
2792                 let _ = self.total_consistency_lock.read().unwrap();
2793                 handle_error!(self, self.internal_closing_signed(their_node_id, msg), their_node_id)
2794         }
2795
2796         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), msgs::HandleError> {
2797                 let _ = self.total_consistency_lock.read().unwrap();
2798                 handle_error!(self, self.internal_update_add_htlc(their_node_id, msg), their_node_id)
2799         }
2800
2801         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), HandleError> {
2802                 let _ = self.total_consistency_lock.read().unwrap();
2803                 handle_error!(self, self.internal_update_fulfill_htlc(their_node_id, msg), their_node_id)
2804         }
2805
2806         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), HandleError> {
2807                 let _ = self.total_consistency_lock.read().unwrap();
2808                 handle_error!(self, self.internal_update_fail_htlc(their_node_id, msg), their_node_id)
2809         }
2810
2811         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), HandleError> {
2812                 let _ = self.total_consistency_lock.read().unwrap();
2813                 handle_error!(self, self.internal_update_fail_malformed_htlc(their_node_id, msg), their_node_id)
2814         }
2815
2816         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), HandleError> {
2817                 let _ = self.total_consistency_lock.read().unwrap();
2818                 handle_error!(self, self.internal_commitment_signed(their_node_id, msg), their_node_id)
2819         }
2820
2821         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), HandleError> {
2822                 let _ = self.total_consistency_lock.read().unwrap();
2823                 handle_error!(self, self.internal_revoke_and_ack(their_node_id, msg), their_node_id)
2824         }
2825
2826         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), HandleError> {
2827                 let _ = self.total_consistency_lock.read().unwrap();
2828                 handle_error!(self, self.internal_update_fee(their_node_id, msg), their_node_id)
2829         }
2830
2831         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), HandleError> {
2832                 let _ = self.total_consistency_lock.read().unwrap();
2833                 handle_error!(self, self.internal_announcement_signatures(their_node_id, msg), their_node_id)
2834         }
2835
2836         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), HandleError> {
2837                 let _ = self.total_consistency_lock.read().unwrap();
2838                 handle_error!(self, self.internal_channel_reestablish(their_node_id, msg), their_node_id)
2839         }
2840
2841         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2842                 let _ = self.total_consistency_lock.read().unwrap();
2843                 let mut failed_channels = Vec::new();
2844                 let mut failed_payments = Vec::new();
2845                 {
2846                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2847                         let channel_state = channel_state_lock.borrow_parts();
2848                         let short_to_id = channel_state.short_to_id;
2849                         let pending_msg_events = channel_state.pending_msg_events;
2850                         if no_connection_possible {
2851                                 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
2852                                 channel_state.by_id.retain(|_, chan| {
2853                                         if chan.get_their_node_id() == *their_node_id {
2854                                                 if let Some(short_id) = chan.get_short_channel_id() {
2855                                                         short_to_id.remove(&short_id);
2856                                                 }
2857                                                 failed_channels.push(chan.force_shutdown());
2858                                                 if let Ok(update) = self.get_channel_update(&chan) {
2859                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2860                                                                 msg: update
2861                                                         });
2862                                                 }
2863                                                 false
2864                                         } else {
2865                                                 true
2866                                         }
2867                                 });
2868                         } else {
2869                                 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
2870                                 channel_state.by_id.retain(|_, chan| {
2871                                         if chan.get_their_node_id() == *their_node_id {
2872                                                 //TODO: mark channel disabled (and maybe announce such after a timeout).
2873                                                 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2874                                                 if !failed_adds.is_empty() {
2875                                                         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
2876                                                         failed_payments.push((chan_update, failed_adds));
2877                                                 }
2878                                                 if chan.is_shutdown() {
2879                                                         if let Some(short_id) = chan.get_short_channel_id() {
2880                                                                 short_to_id.remove(&short_id);
2881                                                         }
2882                                                         return false;
2883                                                 }
2884                                         }
2885                                         true
2886                                 })
2887                         }
2888                 }
2889                 for failure in failed_channels.drain(..) {
2890                         self.finish_force_close_channel(failure);
2891                 }
2892                 for (chan_update, mut htlc_sources) in failed_payments {
2893                         for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2894                                 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2895                         }
2896                 }
2897         }
2898
2899         fn peer_connected(&self, their_node_id: &PublicKey) {
2900                 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
2901
2902                 let _ = self.total_consistency_lock.read().unwrap();
2903                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2904                 let channel_state = channel_state_lock.borrow_parts();
2905                 let pending_msg_events = channel_state.pending_msg_events;
2906                 channel_state.by_id.retain(|_, chan| {
2907                         if chan.get_their_node_id() == *their_node_id {
2908                                 if !chan.have_received_message() {
2909                                         // If we created this (outbound) channel while we were disconnected from the
2910                                         // peer we probably failed to send the open_channel message, which is now
2911                                         // lost. We can't have had anything pending related to this channel, so we just
2912                                         // drop it.
2913                                         false
2914                                 } else {
2915                                         pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
2916                                                 node_id: chan.get_their_node_id(),
2917                                                 msg: chan.get_channel_reestablish(),
2918                                         });
2919                                         true
2920                                 }
2921                         } else { true }
2922                 });
2923                 //TODO: Also re-broadcast announcement_signatures
2924         }
2925
2926         fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
2927                 let _ = self.total_consistency_lock.read().unwrap();
2928
2929                 if msg.channel_id == [0; 32] {
2930                         for chan in self.list_channels() {
2931                                 if chan.remote_network_id == *their_node_id {
2932                                         self.force_close_channel(&chan.channel_id);
2933                                 }
2934                         }
2935                 } else {
2936                         self.force_close_channel(&msg.channel_id);
2937                 }
2938         }
2939 }
2940
2941 const SERIALIZATION_VERSION: u8 = 1;
2942 const MIN_SERIALIZATION_VERSION: u8 = 1;
2943
2944 impl Writeable for PendingForwardHTLCInfo {
2945         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2946                 if let &Some(ref onion) = &self.onion_packet {
2947                         1u8.write(writer)?;
2948                         onion.write(writer)?;
2949                 } else {
2950                         0u8.write(writer)?;
2951                 }
2952                 self.incoming_shared_secret.write(writer)?;
2953                 self.payment_hash.write(writer)?;
2954                 self.short_channel_id.write(writer)?;
2955                 self.amt_to_forward.write(writer)?;
2956                 self.outgoing_cltv_value.write(writer)?;
2957                 Ok(())
2958         }
2959 }
2960
2961 impl<R: ::std::io::Read> Readable<R> for PendingForwardHTLCInfo {
2962         fn read(reader: &mut R) -> Result<PendingForwardHTLCInfo, DecodeError> {
2963                 let onion_packet = match <u8 as Readable<R>>::read(reader)? {
2964                         0 => None,
2965                         1 => Some(msgs::OnionPacket::read(reader)?),
2966                         _ => return Err(DecodeError::InvalidValue),
2967                 };
2968                 Ok(PendingForwardHTLCInfo {
2969                         onion_packet,
2970                         incoming_shared_secret: Readable::read(reader)?,
2971                         payment_hash: Readable::read(reader)?,
2972                         short_channel_id: Readable::read(reader)?,
2973                         amt_to_forward: Readable::read(reader)?,
2974                         outgoing_cltv_value: Readable::read(reader)?,
2975                 })
2976         }
2977 }
2978
2979 impl Writeable for HTLCFailureMsg {
2980         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
2981                 match self {
2982                         &HTLCFailureMsg::Relay(ref fail_msg) => {
2983                                 0u8.write(writer)?;
2984                                 fail_msg.write(writer)?;
2985                         },
2986                         &HTLCFailureMsg::Malformed(ref fail_msg) => {
2987                                 1u8.write(writer)?;
2988                                 fail_msg.write(writer)?;
2989                         }
2990                 }
2991                 Ok(())
2992         }
2993 }
2994
2995 impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
2996         fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
2997                 match <u8 as Readable<R>>::read(reader)? {
2998                         0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
2999                         1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
3000                         _ => Err(DecodeError::InvalidValue),
3001                 }
3002         }
3003 }
3004
3005 impl Writeable for PendingHTLCStatus {
3006         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3007                 match self {
3008                         &PendingHTLCStatus::Forward(ref forward_info) => {
3009                                 0u8.write(writer)?;
3010                                 forward_info.write(writer)?;
3011                         },
3012                         &PendingHTLCStatus::Fail(ref fail_msg) => {
3013                                 1u8.write(writer)?;
3014                                 fail_msg.write(writer)?;
3015                         }
3016                 }
3017                 Ok(())
3018         }
3019 }
3020
3021 impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
3022         fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
3023                 match <u8 as Readable<R>>::read(reader)? {
3024                         0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
3025                         1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
3026                         _ => Err(DecodeError::InvalidValue),
3027                 }
3028         }
3029 }
3030
3031 impl_writeable!(HTLCPreviousHopData, 0, {
3032         short_channel_id,
3033         htlc_id,
3034         incoming_packet_shared_secret
3035 });
3036
3037 impl Writeable for HTLCSource {
3038         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3039                 match self {
3040                         &HTLCSource::PreviousHopData(ref hop_data) => {
3041                                 0u8.write(writer)?;
3042                                 hop_data.write(writer)?;
3043                         },
3044                         &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } => {
3045                                 1u8.write(writer)?;
3046                                 route.write(writer)?;
3047                                 session_priv.write(writer)?;
3048                                 first_hop_htlc_msat.write(writer)?;
3049                         }
3050                 }
3051                 Ok(())
3052         }
3053 }
3054
3055 impl<R: ::std::io::Read> Readable<R> for HTLCSource {
3056         fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
3057                 match <u8 as Readable<R>>::read(reader)? {
3058                         0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
3059                         1 => Ok(HTLCSource::OutboundRoute {
3060                                 route: Readable::read(reader)?,
3061                                 session_priv: Readable::read(reader)?,
3062                                 first_hop_htlc_msat: Readable::read(reader)?,
3063                         }),
3064                         _ => Err(DecodeError::InvalidValue),
3065                 }
3066         }
3067 }
3068
3069 impl Writeable for HTLCFailReason {
3070         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3071                 match self {
3072                         &HTLCFailReason::ErrorPacket { ref err } => {
3073                                 0u8.write(writer)?;
3074                                 err.write(writer)?;
3075                         },
3076                         &HTLCFailReason::Reason { ref failure_code, ref data } => {
3077                                 1u8.write(writer)?;
3078                                 failure_code.write(writer)?;
3079                                 data.write(writer)?;
3080                         }
3081                 }
3082                 Ok(())
3083         }
3084 }
3085
3086 impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
3087         fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
3088                 match <u8 as Readable<R>>::read(reader)? {
3089                         0 => Ok(HTLCFailReason::ErrorPacket { err: Readable::read(reader)? }),
3090                         1 => Ok(HTLCFailReason::Reason {
3091                                 failure_code: Readable::read(reader)?,
3092                                 data: Readable::read(reader)?,
3093                         }),
3094                         _ => Err(DecodeError::InvalidValue),
3095                 }
3096         }
3097 }
3098
3099 impl_writeable!(HTLCForwardInfo, 0, {
3100         prev_short_channel_id,
3101         prev_htlc_id,
3102         forward_info
3103 });
3104
3105 impl Writeable for ChannelManager {
3106         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3107                 let _ = self.total_consistency_lock.write().unwrap();
3108
3109                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3110                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3111
3112                 self.genesis_hash.write(writer)?;
3113                 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
3114                 self.last_block_hash.lock().unwrap().write(writer)?;
3115
3116                 let channel_state = self.channel_state.lock().unwrap();
3117                 let mut unfunded_channels = 0;
3118                 for (_, channel) in channel_state.by_id.iter() {
3119                         if !channel.is_funding_initiated() {
3120                                 unfunded_channels += 1;
3121                         }
3122                 }
3123                 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
3124                 for (_, channel) in channel_state.by_id.iter() {
3125                         if channel.is_funding_initiated() {
3126                                 channel.write(writer)?;
3127                         }
3128                 }
3129
3130                 (channel_state.forward_htlcs.len() as u64).write(writer)?;
3131                 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
3132                         short_channel_id.write(writer)?;
3133                         (pending_forwards.len() as u64).write(writer)?;
3134                         for forward in pending_forwards {
3135                                 forward.write(writer)?;
3136                         }
3137                 }
3138
3139                 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
3140                 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
3141                         payment_hash.write(writer)?;
3142                         (previous_hops.len() as u64).write(writer)?;
3143                         for previous_hop in previous_hops {
3144                                 previous_hop.write(writer)?;
3145                         }
3146                 }
3147
3148                 Ok(())
3149         }
3150 }
3151
3152 /// Arguments for the creation of a ChannelManager that are not deserialized.
3153 ///
3154 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3155 /// is:
3156 /// 1) Deserialize all stored ChannelMonitors.
3157 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3158 ///    ChannelManager)>::read(reader, args).
3159 ///    This may result in closing some Channels if the ChannelMonitor is newer than the stored
3160 ///    ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3161 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3162 ///    ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3163 /// 4) Reconnect blocks on your ChannelMonitors.
3164 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3165 /// 6) Disconnect/connect blocks on the ChannelManager.
3166 /// 7) Register the new ChannelManager with your ChainWatchInterface (this does not happen
3167 ///    automatically as it does in ChannelManager::new()).
3168 pub struct ChannelManagerReadArgs<'a> {
3169         /// The keys provider which will give us relevant keys. Some keys will be loaded during
3170         /// deserialization.
3171         pub keys_manager: Arc<KeysInterface>,
3172
3173         /// The fee_estimator for use in the ChannelManager in the future.
3174         ///
3175         /// No calls to the FeeEstimator will be made during deserialization.
3176         pub fee_estimator: Arc<FeeEstimator>,
3177         /// The ManyChannelMonitor for use in the ChannelManager in the future.
3178         ///
3179         /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3180         /// you have deserialized ChannelMonitors separately and will add them to your
3181         /// ManyChannelMonitor after deserializing this ChannelManager.
3182         pub monitor: Arc<ManyChannelMonitor>,
3183         /// The ChainWatchInterface for use in the ChannelManager in the future.
3184         ///
3185         /// No calls to the ChainWatchInterface will be made during deserialization.
3186         pub chain_monitor: Arc<ChainWatchInterface>,
3187         /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3188         /// used to broadcast the latest local commitment transactions of channels which must be
3189         /// force-closed during deserialization.
3190         pub tx_broadcaster: Arc<BroadcasterInterface>,
3191         /// The Logger for use in the ChannelManager and which may be used to log information during
3192         /// deserialization.
3193         pub logger: Arc<Logger>,
3194         /// Default settings used for new channels. Any existing channels will continue to use the
3195         /// runtime settings which were stored when the ChannelManager was serialized.
3196         pub default_config: UserConfig,
3197
3198         /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3199         /// value.get_funding_txo() should be the key).
3200         ///
3201         /// If a monitor is inconsistent with the channel state during deserialization the channel will
3202         /// be force-closed using the data in the channelmonitor and the Channel will be dropped. This
3203         /// is true for missing channels as well. If there is a monitor missing for which we find
3204         /// channel data Err(DecodeError::InvalidValue) will be returned.
3205         ///
3206         /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3207         /// this struct.
3208         pub channel_monitors: &'a HashMap<OutPoint, &'a ChannelMonitor>,
3209 }
3210
3211 impl<'a, R : ::std::io::Read> ReadableArgs<R, ChannelManagerReadArgs<'a>> for (Sha256dHash, ChannelManager) {
3212         fn read(reader: &mut R, args: ChannelManagerReadArgs<'a>) -> Result<Self, DecodeError> {
3213                 let _ver: u8 = Readable::read(reader)?;
3214                 let min_ver: u8 = Readable::read(reader)?;
3215                 if min_ver > SERIALIZATION_VERSION {
3216                         return Err(DecodeError::UnknownVersion);
3217                 }
3218
3219                 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3220                 let latest_block_height: u32 = Readable::read(reader)?;
3221                 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3222
3223                 let mut closed_channels = Vec::new();
3224
3225                 let channel_count: u64 = Readable::read(reader)?;
3226                 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3227                 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3228                 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3229                 for _ in 0..channel_count {
3230                         let mut channel: Channel = ReadableArgs::read(reader, args.logger.clone())?;
3231                         if channel.last_block_connected != last_block_hash {
3232                                 return Err(DecodeError::InvalidValue);
3233                         }
3234
3235                         let funding_txo = channel.channel_monitor().get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3236                         funding_txo_set.insert(funding_txo.clone());
3237                         if let Some(monitor) = args.channel_monitors.get(&funding_txo) {
3238                                 if channel.get_cur_local_commitment_transaction_number() != monitor.get_cur_local_commitment_number() ||
3239                                                 channel.get_revoked_remote_commitment_transaction_number() != monitor.get_min_seen_secret() ||
3240                                                 channel.get_cur_remote_commitment_transaction_number() != monitor.get_cur_remote_commitment_number() {
3241                                         let mut force_close_res = channel.force_shutdown();
3242                                         force_close_res.0 = monitor.get_latest_local_commitment_txn();
3243                                         closed_channels.push(force_close_res);
3244                                 } else {
3245                                         if let Some(short_channel_id) = channel.get_short_channel_id() {
3246                                                 short_to_id.insert(short_channel_id, channel.channel_id());
3247                                         }
3248                                         by_id.insert(channel.channel_id(), channel);
3249                                 }
3250                         } else {
3251                                 return Err(DecodeError::InvalidValue);
3252                         }
3253                 }
3254
3255                 for (ref funding_txo, ref monitor) in args.channel_monitors.iter() {
3256                         if !funding_txo_set.contains(funding_txo) {
3257                                 closed_channels.push((monitor.get_latest_local_commitment_txn(), Vec::new()));
3258                         }
3259                 }
3260
3261                 let forward_htlcs_count: u64 = Readable::read(reader)?;
3262                 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3263                 for _ in 0..forward_htlcs_count {
3264                         let short_channel_id = Readable::read(reader)?;
3265                         let pending_forwards_count: u64 = Readable::read(reader)?;
3266                         let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3267                         for _ in 0..pending_forwards_count {
3268                                 pending_forwards.push(Readable::read(reader)?);
3269                         }
3270                         forward_htlcs.insert(short_channel_id, pending_forwards);
3271                 }
3272
3273                 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3274                 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3275                 for _ in 0..claimable_htlcs_count {
3276                         let payment_hash = Readable::read(reader)?;
3277                         let previous_hops_len: u64 = Readable::read(reader)?;
3278                         let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3279                         for _ in 0..previous_hops_len {
3280                                 previous_hops.push(Readable::read(reader)?);
3281                         }
3282                         claimable_htlcs.insert(payment_hash, previous_hops);
3283                 }
3284
3285                 let channel_manager = ChannelManager {
3286                         genesis_hash,
3287                         fee_estimator: args.fee_estimator,
3288                         monitor: args.monitor,
3289                         chain_monitor: args.chain_monitor,
3290                         tx_broadcaster: args.tx_broadcaster,
3291
3292                         latest_block_height: AtomicUsize::new(latest_block_height as usize),
3293                         last_block_hash: Mutex::new(last_block_hash),
3294                         secp_ctx: Secp256k1::new(),
3295
3296                         channel_state: Mutex::new(ChannelHolder {
3297                                 by_id,
3298                                 short_to_id,
3299                                 next_forward: Instant::now(),
3300                                 forward_htlcs,
3301                                 claimable_htlcs,
3302                                 pending_msg_events: Vec::new(),
3303                         }),
3304                         our_network_key: args.keys_manager.get_node_secret(),
3305
3306                         pending_events: Mutex::new(Vec::new()),
3307                         total_consistency_lock: RwLock::new(()),
3308                         keys_manager: args.keys_manager,
3309                         logger: args.logger,
3310                         default_configuration: args.default_config,
3311                 };
3312
3313                 for close_res in closed_channels.drain(..) {
3314                         channel_manager.finish_force_close_channel(close_res);
3315                         //TODO: Broadcast channel update for closed channels, but only after we've made a
3316                         //connection or two.
3317                 }
3318
3319                 Ok((last_block_hash.clone(), channel_manager))
3320         }
3321 }
3322
3323 #[cfg(test)]
3324 mod tests {
3325         use chain::chaininterface;
3326         use chain::transaction::OutPoint;
3327         use chain::chaininterface::{ChainListener, ChainWatchInterface};
3328         use chain::keysinterface::{KeysInterface, SpendableOutputDescriptor};
3329         use chain::keysinterface;
3330         use ln::channel::{COMMITMENT_TX_BASE_WEIGHT, COMMITMENT_TX_WEIGHT_PER_HTLC};
3331         use ln::channelmanager::{ChannelManager,ChannelManagerReadArgs,OnionKeys,PaymentFailReason,RAACommitmentOrder};
3332         use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, CLTV_CLAIM_BUFFER, HTLC_FAIL_TIMEOUT_BLOCKS, ManyChannelMonitor};
3333         use ln::router::{Route, RouteHop, Router};
3334         use ln::msgs;
3335         use ln::msgs::{ChannelMessageHandler,RoutingMessageHandler};
3336         use util::test_utils;
3337         use util::events::{Event, EventsProvider, MessageSendEvent, MessageSendEventsProvider};
3338         use util::errors::APIError;
3339         use util::logger::Logger;
3340         use util::ser::{Writeable, Writer, ReadableArgs};
3341         use util::config::UserConfig;
3342
3343         use bitcoin::util::hash::{BitcoinHash, Sha256dHash};
3344         use bitcoin::util::bip143;
3345         use bitcoin::util::address::Address;
3346         use bitcoin::util::bip32::{ChildNumber, ExtendedPubKey, ExtendedPrivKey};
3347         use bitcoin::blockdata::block::{Block, BlockHeader};
3348         use bitcoin::blockdata::transaction::{Transaction, TxOut, TxIn, SigHashType};
3349         use bitcoin::blockdata::script::{Builder, Script};
3350         use bitcoin::blockdata::opcodes;
3351         use bitcoin::blockdata::constants::genesis_block;
3352         use bitcoin::network::constants::Network;
3353
3354         use hex;
3355
3356         use secp256k1::{Secp256k1, Message};
3357         use secp256k1::key::{PublicKey,SecretKey};
3358
3359         use crypto::sha2::Sha256;
3360         use crypto::digest::Digest;
3361
3362         use rand::{thread_rng,Rng};
3363
3364         use std::cell::RefCell;
3365         use std::collections::{BTreeSet, HashMap};
3366         use std::default::Default;
3367         use std::rc::Rc;
3368         use std::sync::{Arc, Mutex};
3369         use std::sync::atomic::Ordering;
3370         use std::time::Instant;
3371         use std::mem;
3372
3373         fn build_test_onion_keys() -> Vec<OnionKeys> {
3374                 // Keys from BOLT 4, used in both test vector tests
3375                 let secp_ctx = Secp256k1::new();
3376
3377                 let route = Route {
3378                         hops: vec!(
3379                                         RouteHop {
3380                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]).unwrap(),
3381                                                 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
3382                                         },
3383                                         RouteHop {
3384                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("0324653eac434488002cc06bbfb7f10fe18991e35f9fe4302dbea6d2353dc0ab1c").unwrap()[..]).unwrap(),
3385                                                 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
3386                                         },
3387                                         RouteHop {
3388                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("027f31ebc5462c1fdce1b737ecff52d37d75dea43ce11c74d25aa297165faa2007").unwrap()[..]).unwrap(),
3389                                                 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
3390                                         },
3391                                         RouteHop {
3392                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("032c0b7cf95324a07d05398b240174dc0c2be444d96b159aa6c7f7b1e668680991").unwrap()[..]).unwrap(),
3393                                                 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
3394                                         },
3395                                         RouteHop {
3396                                                 pubkey: PublicKey::from_slice(&secp_ctx, &hex::decode("02edabbd16b41c8371b92ef2f04c1185b4f03b6dcd52ba9b78d9d7c89c8f221145").unwrap()[..]).unwrap(),
3397                                                 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
3398                                         },
3399                         ),
3400                 };
3401
3402                 let session_priv = SecretKey::from_slice(&secp_ctx, &hex::decode("4141414141414141414141414141414141414141414141414141414141414141").unwrap()[..]).unwrap();
3403
3404                 let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
3405                 assert_eq!(onion_keys.len(), route.hops.len());
3406                 onion_keys
3407         }
3408
3409         #[test]
3410         fn onion_vectors() {
3411                 // Packet creation test vectors from BOLT 4
3412                 let onion_keys = build_test_onion_keys();
3413
3414                 assert_eq!(onion_keys[0].shared_secret[..], hex::decode("53eb63ea8a3fec3b3cd433b85cd62a4b145e1dda09391b348c4e1cd36a03ea66").unwrap()[..]);
3415                 assert_eq!(onion_keys[0].blinding_factor[..], hex::decode("2ec2e5da605776054187180343287683aa6a51b4b1c04d6dd49c45d8cffb3c36").unwrap()[..]);
3416                 assert_eq!(onion_keys[0].ephemeral_pubkey.serialize()[..], hex::decode("02eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619").unwrap()[..]);
3417                 assert_eq!(onion_keys[0].rho, hex::decode("ce496ec94def95aadd4bec15cdb41a740c9f2b62347c4917325fcc6fb0453986").unwrap()[..]);
3418                 assert_eq!(onion_keys[0].mu, hex::decode("b57061dc6d0a2b9f261ac410c8b26d64ac5506cbba30267a649c28c179400eba").unwrap()[..]);
3419
3420                 assert_eq!(onion_keys[1].shared_secret[..], hex::decode("a6519e98832a0b179f62123b3567c106db99ee37bef036e783263602f3488fae").unwrap()[..]);
3421                 assert_eq!(onion_keys[1].blinding_factor[..], hex::decode("bf66c28bc22e598cfd574a1931a2bafbca09163df2261e6d0056b2610dab938f").unwrap()[..]);
3422                 assert_eq!(onion_keys[1].ephemeral_pubkey.serialize()[..], hex::decode("028f9438bfbf7feac2e108d677e3a82da596be706cc1cf342b75c7b7e22bf4e6e2").unwrap()[..]);
3423                 assert_eq!(onion_keys[1].rho, hex::decode("450ffcabc6449094918ebe13d4f03e433d20a3d28a768203337bc40b6e4b2c59").unwrap()[..]);
3424                 assert_eq!(onion_keys[1].mu, hex::decode("05ed2b4a3fb023c2ff5dd6ed4b9b6ea7383f5cfe9d59c11d121ec2c81ca2eea9").unwrap()[..]);
3425
3426                 assert_eq!(onion_keys[2].shared_secret[..], hex::decode("3a6b412548762f0dbccce5c7ae7bb8147d1caf9b5471c34120b30bc9c04891cc").unwrap()[..]);
3427                 assert_eq!(onion_keys[2].blinding_factor[..], hex::decode("a1f2dadd184eb1627049673f18c6325814384facdee5bfd935d9cb031a1698a5").unwrap()[..]);
3428                 assert_eq!(onion_keys[2].ephemeral_pubkey.serialize()[..], hex::decode("03bfd8225241ea71cd0843db7709f4c222f62ff2d4516fd38b39914ab6b83e0da0").unwrap()[..]);
3429                 assert_eq!(onion_keys[2].rho, hex::decode("11bf5c4f960239cb37833936aa3d02cea82c0f39fd35f566109c41f9eac8deea").unwrap()[..]);
3430                 assert_eq!(onion_keys[2].mu, hex::decode("caafe2820fa00eb2eeb78695ae452eba38f5a53ed6d53518c5c6edf76f3f5b78").unwrap()[..]);
3431
3432                 assert_eq!(onion_keys[3].shared_secret[..], hex::decode("21e13c2d7cfe7e18836df50872466117a295783ab8aab0e7ecc8c725503ad02d").unwrap()[..]);
3433                 assert_eq!(onion_keys[3].blinding_factor[..], hex::decode("7cfe0b699f35525029ae0fa437c69d0f20f7ed4e3916133f9cacbb13c82ff262").unwrap()[..]);
3434                 assert_eq!(onion_keys[3].ephemeral_pubkey.serialize()[..], hex::decode("031dde6926381289671300239ea8e57ffaf9bebd05b9a5b95beaf07af05cd43595").unwrap()[..]);
3435                 assert_eq!(onion_keys[3].rho, hex::decode("cbe784ab745c13ff5cffc2fbe3e84424aa0fd669b8ead4ee562901a4a4e89e9e").unwrap()[..]);
3436                 assert_eq!(onion_keys[3].mu, hex::decode("5052aa1b3d9f0655a0932e50d42f0c9ba0705142c25d225515c45f47c0036ee9").unwrap()[..]);
3437
3438                 assert_eq!(onion_keys[4].shared_secret[..], hex::decode("b5756b9b542727dbafc6765a49488b023a725d631af688fc031217e90770c328").unwrap()[..]);
3439                 assert_eq!(onion_keys[4].blinding_factor[..], hex::decode("c96e00dddaf57e7edcd4fb5954be5b65b09f17cb6d20651b4e90315be5779205").unwrap()[..]);
3440                 assert_eq!(onion_keys[4].ephemeral_pubkey.serialize()[..], hex::decode("03a214ebd875aab6ddfd77f22c5e7311d7f77f17a169e599f157bbcdae8bf071f4").unwrap()[..]);
3441                 assert_eq!(onion_keys[4].rho, hex::decode("034e18b8cc718e8af6339106e706c52d8df89e2b1f7e9142d996acf88df8799b").unwrap()[..]);
3442                 assert_eq!(onion_keys[4].mu, hex::decode("8e45e5c61c2b24cb6382444db6698727afb063adecd72aada233d4bf273d975a").unwrap()[..]);
3443
3444                 // Test vectors below are flat-out wrong: they claim to set outgoing_cltv_value to non-0 :/
3445                 let payloads = vec!(
3446                         msgs::OnionHopData {
3447                                 realm: 0,
3448                                 data: msgs::OnionRealm0HopData {
3449                                         short_channel_id: 0,
3450                                         amt_to_forward: 0,
3451                                         outgoing_cltv_value: 0,
3452                                 },
3453                                 hmac: [0; 32],
3454                         },
3455                         msgs::OnionHopData {
3456                                 realm: 0,
3457                                 data: msgs::OnionRealm0HopData {
3458                                         short_channel_id: 0x0101010101010101,
3459                                         amt_to_forward: 0x0100000001,
3460                                         outgoing_cltv_value: 0,
3461                                 },
3462                                 hmac: [0; 32],
3463                         },
3464                         msgs::OnionHopData {
3465                                 realm: 0,
3466                                 data: msgs::OnionRealm0HopData {
3467                                         short_channel_id: 0x0202020202020202,
3468                                         amt_to_forward: 0x0200000002,
3469                                         outgoing_cltv_value: 0,
3470                                 },
3471                                 hmac: [0; 32],
3472                         },
3473                         msgs::OnionHopData {
3474                                 realm: 0,
3475                                 data: msgs::OnionRealm0HopData {
3476                                         short_channel_id: 0x0303030303030303,
3477                                         amt_to_forward: 0x0300000003,
3478                                         outgoing_cltv_value: 0,
3479                                 },
3480                                 hmac: [0; 32],
3481                         },
3482                         msgs::OnionHopData {
3483                                 realm: 0,
3484                                 data: msgs::OnionRealm0HopData {
3485                                         short_channel_id: 0x0404040404040404,
3486                                         amt_to_forward: 0x0400000004,
3487                                         outgoing_cltv_value: 0,
3488                                 },
3489                                 hmac: [0; 32],
3490                         },
3491                 );
3492
3493                 let packet = ChannelManager::construct_onion_packet(payloads, onion_keys, &[0x42; 32]);
3494                 // Just check the final packet encoding, as it includes all the per-hop vectors in it
3495                 // anyway...
3496                 assert_eq!(packet.encode(), hex::decode("0002eec7245d6b7d2ccb30380bfbe2a3648cd7a942653f5aa340edcea1f283686619e5f14350c2a76fc232b5e46d421e9615471ab9e0bc887beff8c95fdb878f7b3a716a996c7845c93d90e4ecbb9bde4ece2f69425c99e4bc820e44485455f135edc0d10f7d61ab590531cf08000179a333a347f8b4072f216400406bdf3bf038659793d4a1fd7b246979e3150a0a4cb052c9ec69acf0f48c3d39cd55675fe717cb7d80ce721caad69320c3a469a202f1e468c67eaf7a7cd8226d0fd32f7b48084dca885d56047694762b67021713ca673929c163ec36e04e40ca8e1c6d17569419d3039d9a1ec866abe044a9ad635778b961fc0776dc832b3a451bd5d35072d2269cf9b040f6b7a7dad84fb114ed413b1426cb96ceaf83825665ed5a1d002c1687f92465b49ed4c7f0218ff8c6c7dd7221d589c65b3b9aaa71a41484b122846c7c7b57e02e679ea8469b70e14fe4f70fee4d87b910cf144be6fe48eef24da475c0b0bcc6565ae82cd3f4e3b24c76eaa5616c6111343306ab35c1fe5ca4a77c0e314ed7dba39d6f1e0de791719c241a939cc493bea2bae1c1e932679ea94d29084278513c77b899cc98059d06a27d171b0dbdf6bee13ddc4fc17a0c4d2827d488436b57baa167544138ca2e64a11b43ac8a06cd0c2fba2d4d900ed2d9205305e2d7383cc98dacb078133de5f6fb6bed2ef26ba92cea28aafc3b9948dd9ae5559e8bd6920b8cea462aa445ca6a95e0e7ba52961b181c79e73bd581821df2b10173727a810c92b83b5ba4a0403eb710d2ca10689a35bec6c3a708e9e92f7d78ff3c5d9989574b00c6736f84c199256e76e19e78f0c98a9d580b4a658c84fc8f2096c2fbea8f5f8c59d0fdacb3be2802ef802abbecb3aba4acaac69a0e965abd8981e9896b1f6ef9d60f7a164b371af869fd0e48073742825e9434fc54da837e120266d53302954843538ea7c6c3dbfb4ff3b2fdbe244437f2a153ccf7bdb4c92aa08102d4f3cff2ae5ef86fab4653595e6a5837fa2f3e29f27a9cde5966843fb847a4a61f1e76c281fe8bb2b0a181d096100db5a1a5ce7a910238251a43ca556712eaadea167fb4d7d75825e440f3ecd782036d7574df8bceacb397abefc5f5254d2722215c53ff54af8299aaaad642c6d72a14d27882d9bbd539e1cc7a527526ba89b8c037ad09120e98ab042d3e8652b31ae0e478516bfaf88efca9f3676ffe99d2819dcaeb7610a626695f53117665d267d3f7abebd6bbd6733f645c72c389f03855bdf1e4b8075b516569b118233a0f0971d24b83113c0b096f5216a207ca99a7cddc81c130923fe3d91e7508c9ac5f2e914ff5dccab9e558566fa14efb34ac98d878580814b94b73acbfde9072f30b881f7f0fff42d4045d1ace6322d86a97d164aa84d93a60498065cc7c20e636f5862dc81531a88c60305a2e59a985be327a6902e4bed986dbf4a0b50c217af0ea7fdf9ab37f9ea1a1aaa72f54cf40154ea9b269f1a7c09f9f43245109431a175d50e2db0132337baa0ef97eed0fcf20489da36b79a1172faccc2f7ded7c60e00694282d93359c4682135642bc81f433574aa8ef0c97b4ade7ca372c5ffc23c7eddd839bab4e0f14d6df15c9dbeab176bec8b5701cf054eb3072f6dadc98f88819042bf10c407516ee58bce33fbe3b3d86a54255e577db4598e30a135361528c101683a5fcde7e8ba53f3456254be8f45fe3a56120ae96ea3773631fcb3873aa3abd91bcff00bd38bd43697a2e789e00da6077482e7b1b1a677b5afae4c54e6cbdf7377b694eb7d7a5b913476a5be923322d3de06060fd5e819635232a2cf4f0731da13b8546d1d6d4f8d75b9fce6c2341a71b0ea6f780df54bfdb0dd5cd9855179f602f9172307c7268724c3618e6817abd793adc214a0dc0bc616816632f27ea336fb56dfd").unwrap());
3497         }
3498
3499         #[test]
3500         fn test_failure_packet_onion() {
3501                 // Returning Errors test vectors from BOLT 4
3502
3503                 let onion_keys = build_test_onion_keys();
3504                 let onion_error = ChannelManager::build_failure_packet(&onion_keys[4].shared_secret[..], 0x2002, &[0; 0]);
3505                 assert_eq!(onion_error.encode(), hex::decode("4c2fc8bc08510334b6833ad9c3e79cd1b52ae59dfe5c2a4b23ead50f09f7ee0b0002200200fe0000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000").unwrap());
3506
3507                 let onion_packet_1 = ChannelManager::encrypt_failure_packet(&onion_keys[4].shared_secret[..], &onion_error.encode()[..]);
3508                 assert_eq!(onion_packet_1.data, hex::decode("a5e6bd0c74cb347f10cce367f949098f2457d14c046fd8a22cb96efb30b0fdcda8cb9168b50f2fd45edd73c1b0c8b33002df376801ff58aaa94000bf8a86f92620f343baef38a580102395ae3abf9128d1047a0736ff9b83d456740ebbb4aeb3aa9737f18fb4afb4aa074fb26c4d702f42968888550a3bded8c05247e045b866baef0499f079fdaeef6538f31d44deafffdfd3afa2fb4ca9082b8f1c465371a9894dd8c243fb4847e004f5256b3e90e2edde4c9fb3082ddfe4d1e734cacd96ef0706bf63c9984e22dc98851bcccd1c3494351feb458c9c6af41c0044bea3c47552b1d992ae542b17a2d0bba1a096c78d169034ecb55b6e3a7263c26017f033031228833c1daefc0dedb8cf7c3e37c9c37ebfe42f3225c326e8bcfd338804c145b16e34e4").unwrap());
3509
3510                 let onion_packet_2 = ChannelManager::encrypt_failure_packet(&onion_keys[3].shared_secret[..], &onion_packet_1.data[..]);
3511                 assert_eq!(onion_packet_2.data, hex::decode("c49a1ce81680f78f5f2000cda36268de34a3f0a0662f55b4e837c83a8773c22aa081bab1616a0011585323930fa5b9fae0c85770a2279ff59ec427ad1bbff9001c0cd1497004bd2a0f68b50704cf6d6a4bf3c8b6a0833399a24b3456961ba00736785112594f65b6b2d44d9f5ea4e49b5e1ec2af978cbe31c67114440ac51a62081df0ed46d4a3df295da0b0fe25c0115019f03f15ec86fabb4c852f83449e812f141a9395b3f70b766ebbd4ec2fae2b6955bd8f32684c15abfe8fd3a6261e52650e8807a92158d9f1463261a925e4bfba44bd20b166d532f0017185c3a6ac7957adefe45559e3072c8dc35abeba835a8cb01a71a15c736911126f27d46a36168ca5ef7dccd4e2886212602b181463e0dd30185c96348f9743a02aca8ec27c0b90dca270").unwrap());
3512
3513                 let onion_packet_3 = ChannelManager::encrypt_failure_packet(&onion_keys[2].shared_secret[..], &onion_packet_2.data[..]);
3514                 assert_eq!(onion_packet_3.data, hex::decode("a5d3e8634cfe78b2307d87c6d90be6fe7855b4f2cc9b1dfb19e92e4b79103f61ff9ac25f412ddfb7466e74f81b3e545563cdd8f5524dae873de61d7bdfccd496af2584930d2b566b4f8d3881f8c043df92224f38cf094cfc09d92655989531524593ec6d6caec1863bdfaa79229b5020acc034cd6deeea1021c50586947b9b8e6faa83b81fbfa6133c0af5d6b07c017f7158fa94f0d206baf12dda6b68f785b773b360fd0497e16cc402d779c8d48d0fa6315536ef0660f3f4e1865f5b38ea49c7da4fd959de4e83ff3ab686f059a45c65ba2af4a6a79166aa0f496bf04d06987b6d2ea205bdb0d347718b9aeff5b61dfff344993a275b79717cd815b6ad4c0beb568c4ac9c36ff1c315ec1119a1993c4b61e6eaa0375e0aaf738ac691abd3263bf937e3").unwrap());
3515
3516                 let onion_packet_4 = ChannelManager::encrypt_failure_packet(&onion_keys[1].shared_secret[..], &onion_packet_3.data[..]);
3517                 assert_eq!(onion_packet_4.data, hex::decode("aac3200c4968f56b21f53e5e374e3a2383ad2b1b6501bbcc45abc31e59b26881b7dfadbb56ec8dae8857add94e6702fb4c3a4de22e2e669e1ed926b04447fc73034bb730f4932acd62727b75348a648a1128744657ca6a4e713b9b646c3ca66cac02cdab44dd3439890ef3aaf61708714f7375349b8da541b2548d452d84de7084bb95b3ac2345201d624d31f4d52078aa0fa05a88b4e20202bd2b86ac5b52919ea305a8949de95e935eed0319cf3cf19ebea61d76ba92532497fcdc9411d06bcd4275094d0a4a3c5d3a945e43305a5a9256e333e1f64dbca5fcd4e03a39b9012d197506e06f29339dfee3331995b21615337ae060233d39befea925cc262873e0530408e6990f1cbd233a150ef7b004ff6166c70c68d9f8c853c1abca640b8660db2921").unwrap());
3518
3519                 let onion_packet_5 = ChannelManager::encrypt_failure_packet(&onion_keys[0].shared_secret[..], &onion_packet_4.data[..]);
3520                 assert_eq!(onion_packet_5.data, hex::decode("9c5add3963fc7f6ed7f148623c84134b5647e1306419dbe2174e523fa9e2fbed3a06a19f899145610741c83ad40b7712aefaddec8c6baf7325d92ea4ca4d1df8bce517f7e54554608bf2bd8071a4f52a7a2f7ffbb1413edad81eeea5785aa9d990f2865dc23b4bc3c301a94eec4eabebca66be5cf638f693ec256aec514620cc28ee4a94bd9565bc4d4962b9d3641d4278fb319ed2b84de5b665f307a2db0f7fbb757366067d88c50f7e829138fde4f78d39b5b5802f1b92a8a820865af5cc79f9f30bc3f461c66af95d13e5e1f0381c184572a91dee1c849048a647a1158cf884064deddbf1b0b88dfe2f791428d0ba0f6fb2f04e14081f69165ae66d9297c118f0907705c9c4954a199bae0bb96fad763d690e7daa6cfda59ba7f2c8d11448b604d12d").unwrap());
3521         }
3522
3523         fn confirm_transaction(chain: &chaininterface::ChainWatchInterfaceUtil, tx: &Transaction, chan_id: u32) {
3524                 assert!(chain.does_match_tx(tx));
3525                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3526                 chain.block_connected_checked(&header, 1, &[tx; 1], &[chan_id; 1]);
3527                 for i in 2..100 {
3528                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
3529                         chain.block_connected_checked(&header, i, &[tx; 0], &[0; 0]);
3530                 }
3531         }
3532
3533         struct Node {
3534                 chain_monitor: Arc<chaininterface::ChainWatchInterfaceUtil>,
3535                 tx_broadcaster: Arc<test_utils::TestBroadcaster>,
3536                 chan_monitor: Arc<test_utils::TestChannelMonitor>,
3537                 node: Arc<ChannelManager>,
3538                 router: Router,
3539                 node_seed: [u8; 32],
3540                 network_payment_count: Rc<RefCell<u8>>,
3541                 network_chan_count: Rc<RefCell<u32>>,
3542         }
3543         impl Drop for Node {
3544                 fn drop(&mut self) {
3545                         if !::std::thread::panicking() {
3546                                 // Check that we processed all pending events
3547                                 assert_eq!(self.node.get_and_clear_pending_msg_events().len(), 0);
3548                                 assert_eq!(self.node.get_and_clear_pending_events().len(), 0);
3549                                 assert_eq!(self.chan_monitor.added_monitors.lock().unwrap().len(), 0);
3550                         }
3551                 }
3552         }
3553
3554         fn create_chan_between_nodes(node_a: &Node, node_b: &Node) -> (msgs::ChannelAnnouncement, msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3555                 create_chan_between_nodes_with_value(node_a, node_b, 100000, 10001)
3556         }
3557
3558         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) {
3559                 let (funding_locked, channel_id, tx) = create_chan_between_nodes_with_value_a(node_a, node_b, channel_value, push_msat);
3560                 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(node_a, node_b, &funding_locked);
3561                 (announcement, as_update, bs_update, channel_id, tx)
3562         }
3563
3564         macro_rules! get_revoke_commit_msgs {
3565                 ($node: expr, $node_id: expr) => {
3566                         {
3567                                 let events = $node.node.get_and_clear_pending_msg_events();
3568                                 assert_eq!(events.len(), 2);
3569                                 (match events[0] {
3570                                         MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3571                                                 assert_eq!(*node_id, $node_id);
3572                                                 (*msg).clone()
3573                                         },
3574                                         _ => panic!("Unexpected event"),
3575                                 }, match events[1] {
3576                                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3577                                                 assert_eq!(*node_id, $node_id);
3578                                                 assert!(updates.update_add_htlcs.is_empty());
3579                                                 assert!(updates.update_fulfill_htlcs.is_empty());
3580                                                 assert!(updates.update_fail_htlcs.is_empty());
3581                                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
3582                                                 assert!(updates.update_fee.is_none());
3583                                                 updates.commitment_signed.clone()
3584                                         },
3585                                         _ => panic!("Unexpected event"),
3586                                 })
3587                         }
3588                 }
3589         }
3590
3591         macro_rules! get_event_msg {
3592                 ($node: expr, $event_type: path, $node_id: expr) => {
3593                         {
3594                                 let events = $node.node.get_and_clear_pending_msg_events();
3595                                 assert_eq!(events.len(), 1);
3596                                 match events[0] {
3597                                         $event_type { ref node_id, ref msg } => {
3598                                                 assert_eq!(*node_id, $node_id);
3599                                                 (*msg).clone()
3600                                         },
3601                                         _ => panic!("Unexpected event"),
3602                                 }
3603                         }
3604                 }
3605         }
3606
3607         macro_rules! get_htlc_update_msgs {
3608                 ($node: expr, $node_id: expr) => {
3609                         {
3610                                 let events = $node.node.get_and_clear_pending_msg_events();
3611                                 assert_eq!(events.len(), 1);
3612                                 match events[0] {
3613                                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
3614                                                 assert_eq!(*node_id, $node_id);
3615                                                 (*updates).clone()
3616                                         },
3617                                         _ => panic!("Unexpected event"),
3618                                 }
3619                         }
3620                 }
3621         }
3622
3623         macro_rules! get_feerate {
3624                 ($node: expr, $channel_id: expr) => {
3625                         {
3626                                 let chan_lock = $node.node.channel_state.lock().unwrap();
3627                                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
3628                                 chan.get_feerate()
3629                         }
3630                 }
3631         }
3632
3633
3634         fn create_chan_between_nodes_with_value_init(node_a: &Node, node_b: &Node, channel_value: u64, push_msat: u64) -> Transaction {
3635                 node_a.node.create_channel(node_b.node.get_our_node_id(), channel_value, push_msat, 42).unwrap();
3636                 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();
3637                 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();
3638
3639                 let chan_id = *node_a.network_chan_count.borrow();
3640                 let tx;
3641                 let funding_output;
3642
3643                 let events_2 = node_a.node.get_and_clear_pending_events();
3644                 assert_eq!(events_2.len(), 1);
3645                 match events_2[0] {
3646                         Event::FundingGenerationReady { ref temporary_channel_id, ref channel_value_satoshis, ref output_script, user_channel_id } => {
3647                                 assert_eq!(*channel_value_satoshis, channel_value);
3648                                 assert_eq!(user_channel_id, 42);
3649
3650                                 tx = Transaction { version: chan_id as u32, lock_time: 0, input: Vec::new(), output: vec![TxOut {
3651                                         value: *channel_value_satoshis, script_pubkey: output_script.clone(),
3652                                 }]};
3653                                 funding_output = OutPoint::new(tx.txid(), 0);
3654
3655                                 node_a.node.funding_transaction_generated(&temporary_channel_id, funding_output);
3656                                 let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
3657                                 assert_eq!(added_monitors.len(), 1);
3658                                 assert_eq!(added_monitors[0].0, funding_output);
3659                                 added_monitors.clear();
3660                         },
3661                         _ => panic!("Unexpected event"),
3662                 }
3663
3664                 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();
3665                 {
3666                         let mut added_monitors = node_b.chan_monitor.added_monitors.lock().unwrap();
3667                         assert_eq!(added_monitors.len(), 1);
3668                         assert_eq!(added_monitors[0].0, funding_output);
3669                         added_monitors.clear();
3670                 }
3671
3672                 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();
3673                 {
3674                         let mut added_monitors = node_a.chan_monitor.added_monitors.lock().unwrap();
3675                         assert_eq!(added_monitors.len(), 1);
3676                         assert_eq!(added_monitors[0].0, funding_output);
3677                         added_monitors.clear();
3678                 }
3679
3680                 let events_4 = node_a.node.get_and_clear_pending_events();
3681                 assert_eq!(events_4.len(), 1);
3682                 match events_4[0] {
3683                         Event::FundingBroadcastSafe { ref funding_txo, user_channel_id } => {
3684                                 assert_eq!(user_channel_id, 42);
3685                                 assert_eq!(*funding_txo, funding_output);
3686                         },
3687                         _ => panic!("Unexpected event"),
3688                 };
3689
3690                 tx
3691         }
3692
3693         fn create_chan_between_nodes_with_value_confirm(node_a: &Node, node_b: &Node, tx: &Transaction) -> ((msgs::FundingLocked, msgs::AnnouncementSignatures), [u8; 32]) {
3694                 confirm_transaction(&node_b.chain_monitor, &tx, tx.version);
3695                 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();
3696
3697                 let channel_id;
3698
3699                 confirm_transaction(&node_a.chain_monitor, &tx, tx.version);
3700                 let events_6 = node_a.node.get_and_clear_pending_msg_events();
3701                 assert_eq!(events_6.len(), 2);
3702                 ((match events_6[0] {
3703                         MessageSendEvent::SendFundingLocked { ref node_id, ref msg } => {
3704                                 channel_id = msg.channel_id.clone();
3705                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
3706                                 msg.clone()
3707                         },
3708                         _ => panic!("Unexpected event"),
3709                 }, match events_6[1] {
3710                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, ref msg } => {
3711                                 assert_eq!(*node_id, node_b.node.get_our_node_id());
3712                                 msg.clone()
3713                         },
3714                         _ => panic!("Unexpected event"),
3715                 }), channel_id)
3716         }
3717
3718         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) {
3719                 let tx = create_chan_between_nodes_with_value_init(node_a, node_b, channel_value, push_msat);
3720                 let (msgs, chan_id) = create_chan_between_nodes_with_value_confirm(node_a, node_b, &tx);
3721                 (msgs, chan_id, tx)
3722         }
3723
3724         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) {
3725                 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &as_funding_msgs.0).unwrap();
3726                 let bs_announcement_sigs = get_event_msg!(node_b, MessageSendEvent::SendAnnouncementSignatures, node_a.node.get_our_node_id());
3727                 node_b.node.handle_announcement_signatures(&node_a.node.get_our_node_id(), &as_funding_msgs.1).unwrap();
3728
3729                 let events_7 = node_b.node.get_and_clear_pending_msg_events();
3730                 assert_eq!(events_7.len(), 1);
3731                 let (announcement, bs_update) = match events_7[0] {
3732                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3733                                 (msg, update_msg)
3734                         },
3735                         _ => panic!("Unexpected event"),
3736                 };
3737
3738                 node_a.node.handle_announcement_signatures(&node_b.node.get_our_node_id(), &bs_announcement_sigs).unwrap();
3739                 let events_8 = node_a.node.get_and_clear_pending_msg_events();
3740                 assert_eq!(events_8.len(), 1);
3741                 let as_update = match events_8[0] {
3742                         MessageSendEvent::BroadcastChannelAnnouncement { ref msg, ref update_msg } => {
3743                                 assert!(*announcement == *msg);
3744                                 update_msg
3745                         },
3746                         _ => panic!("Unexpected event"),
3747                 };
3748
3749                 *node_a.network_chan_count.borrow_mut() += 1;
3750
3751                 ((*announcement).clone(), (*as_update).clone(), (*bs_update).clone())
3752         }
3753
3754         fn create_announced_chan_between_nodes(nodes: &Vec<Node>, a: usize, b: usize) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction) {
3755                 create_announced_chan_between_nodes_with_value(nodes, a, b, 100000, 10001)
3756         }
3757
3758         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) {
3759                 let chan_announcement = create_chan_between_nodes_with_value(&nodes[a], &nodes[b], channel_value, push_msat);
3760                 for node in nodes {
3761                         assert!(node.router.handle_channel_announcement(&chan_announcement.0).unwrap());
3762                         node.router.handle_channel_update(&chan_announcement.1).unwrap();
3763                         node.router.handle_channel_update(&chan_announcement.2).unwrap();
3764                 }
3765                 (chan_announcement.1, chan_announcement.2, chan_announcement.3, chan_announcement.4)
3766         }
3767
3768         macro_rules! check_spends {
3769                 ($tx: expr, $spends_tx: expr) => {
3770                         {
3771                                 let mut funding_tx_map = HashMap::new();
3772                                 let spends_tx = $spends_tx;
3773                                 funding_tx_map.insert(spends_tx.txid(), spends_tx);
3774                                 $tx.verify(&funding_tx_map).unwrap();
3775                         }
3776                 }
3777         }
3778
3779         macro_rules! get_closing_signed_broadcast {
3780                 ($node: expr, $dest_pubkey: expr) => {
3781                         {
3782                                 let events = $node.get_and_clear_pending_msg_events();
3783                                 assert!(events.len() == 1 || events.len() == 2);
3784                                 (match events[events.len() - 1] {
3785                                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
3786                                                 assert_eq!(msg.contents.flags & 2, 2);
3787                                                 msg.clone()
3788                                         },
3789                                         _ => panic!("Unexpected event"),
3790                                 }, if events.len() == 2 {
3791                                         match events[0] {
3792                                                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
3793                                                         assert_eq!(*node_id, $dest_pubkey);
3794                                                         Some(msg.clone())
3795                                                 },
3796                                                 _ => panic!("Unexpected event"),
3797                                         }
3798                                 } else { None })
3799                         }
3800                 }
3801         }
3802
3803         fn close_channel(outbound_node: &Node, inbound_node: &Node, channel_id: &[u8; 32], funding_tx: Transaction, close_inbound_first: bool) -> (msgs::ChannelUpdate, msgs::ChannelUpdate, Transaction) {
3804                 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) };
3805                 let (node_b, broadcaster_b) = if close_inbound_first { (&outbound_node.node, &outbound_node.tx_broadcaster) } else { (&inbound_node.node, &inbound_node.tx_broadcaster) };
3806                 let (tx_a, tx_b);
3807
3808                 node_a.close_channel(channel_id).unwrap();
3809                 node_b.handle_shutdown(&node_a.get_our_node_id(), &get_event_msg!(struct_a, MessageSendEvent::SendShutdown, node_b.get_our_node_id())).unwrap();
3810
3811                 let events_1 = node_b.get_and_clear_pending_msg_events();
3812                 assert!(events_1.len() >= 1);
3813                 let shutdown_b = match events_1[0] {
3814                         MessageSendEvent::SendShutdown { ref node_id, ref msg } => {
3815                                 assert_eq!(node_id, &node_a.get_our_node_id());
3816                                 msg.clone()
3817                         },
3818                         _ => panic!("Unexpected event"),
3819                 };
3820
3821                 let closing_signed_b = if !close_inbound_first {
3822                         assert_eq!(events_1.len(), 1);
3823                         None
3824                 } else {
3825                         Some(match events_1[1] {
3826                                 MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
3827                                         assert_eq!(node_id, &node_a.get_our_node_id());
3828                                         msg.clone()
3829                                 },
3830                                 _ => panic!("Unexpected event"),
3831                         })
3832                 };
3833
3834                 node_a.handle_shutdown(&node_b.get_our_node_id(), &shutdown_b).unwrap();
3835                 let (as_update, bs_update) = if close_inbound_first {
3836                         assert!(node_a.get_and_clear_pending_msg_events().is_empty());
3837                         node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
3838                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
3839                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
3840                         let (as_update, closing_signed_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
3841
3842                         node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a.unwrap()).unwrap();
3843                         let (bs_update, none_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
3844                         assert!(none_b.is_none());
3845                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
3846                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
3847                         (as_update, bs_update)
3848                 } else {
3849                         let closing_signed_a = get_event_msg!(struct_a, MessageSendEvent::SendClosingSigned, node_b.get_our_node_id());
3850
3851                         node_b.handle_closing_signed(&node_a.get_our_node_id(), &closing_signed_a).unwrap();
3852                         assert_eq!(broadcaster_b.txn_broadcasted.lock().unwrap().len(), 1);
3853                         tx_b = broadcaster_b.txn_broadcasted.lock().unwrap().remove(0);
3854                         let (bs_update, closing_signed_b) = get_closing_signed_broadcast!(node_b, node_a.get_our_node_id());
3855
3856                         node_a.handle_closing_signed(&node_b.get_our_node_id(), &closing_signed_b.unwrap()).unwrap();
3857                         let (as_update, none_a) = get_closing_signed_broadcast!(node_a, node_b.get_our_node_id());
3858                         assert!(none_a.is_none());
3859                         assert_eq!(broadcaster_a.txn_broadcasted.lock().unwrap().len(), 1);
3860                         tx_a = broadcaster_a.txn_broadcasted.lock().unwrap().remove(0);
3861                         (as_update, bs_update)
3862                 };
3863                 assert_eq!(tx_a, tx_b);
3864                 check_spends!(tx_a, funding_tx);
3865
3866                 (as_update, bs_update, tx_a)
3867         }
3868
3869         struct SendEvent {
3870                 node_id: PublicKey,
3871                 msgs: Vec<msgs::UpdateAddHTLC>,
3872                 commitment_msg: msgs::CommitmentSigned,
3873         }
3874         impl SendEvent {
3875                 fn from_commitment_update(node_id: PublicKey, updates: msgs::CommitmentUpdate) -> SendEvent {
3876                         assert!(updates.update_fulfill_htlcs.is_empty());
3877                         assert!(updates.update_fail_htlcs.is_empty());
3878                         assert!(updates.update_fail_malformed_htlcs.is_empty());
3879                         assert!(updates.update_fee.is_none());
3880                         SendEvent { node_id: node_id, msgs: updates.update_add_htlcs, commitment_msg: updates.commitment_signed }
3881                 }
3882
3883                 fn from_event(event: MessageSendEvent) -> SendEvent {
3884                         match event {
3885                                 MessageSendEvent::UpdateHTLCs { node_id, updates } => SendEvent::from_commitment_update(node_id, updates),
3886                                 _ => panic!("Unexpected event type!"),
3887                         }
3888                 }
3889
3890                 fn from_node(node: &Node) -> SendEvent {
3891                         let mut events = node.node.get_and_clear_pending_msg_events();
3892                         assert_eq!(events.len(), 1);
3893                         SendEvent::from_event(events.pop().unwrap())
3894                 }
3895         }
3896
3897         macro_rules! check_added_monitors {
3898                 ($node: expr, $count: expr) => {
3899                         {
3900                                 let mut added_monitors = $node.chan_monitor.added_monitors.lock().unwrap();
3901                                 assert_eq!(added_monitors.len(), $count);
3902                                 added_monitors.clear();
3903                         }
3904                 }
3905         }
3906
3907         macro_rules! commitment_signed_dance {
3908                 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */) => {
3909                         {
3910                                 check_added_monitors!($node_a, 0);
3911                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3912                                 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
3913                                 check_added_monitors!($node_a, 1);
3914                                 commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, false);
3915                         }
3916                 };
3917                 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */, true /* return last RAA */) => {
3918                         {
3919                                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!($node_a, $node_b.node.get_our_node_id());
3920                                 check_added_monitors!($node_b, 0);
3921                                 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
3922                                 $node_b.node.handle_revoke_and_ack(&$node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
3923                                 assert!($node_b.node.get_and_clear_pending_msg_events().is_empty());
3924                                 check_added_monitors!($node_b, 1);
3925                                 $node_b.node.handle_commitment_signed(&$node_a.node.get_our_node_id(), &as_commitment_signed).unwrap();
3926                                 let (bs_revoke_and_ack, extra_msg_option) = {
3927                                         let events = $node_b.node.get_and_clear_pending_msg_events();
3928                                         assert!(events.len() <= 2);
3929                                         (match events[0] {
3930                                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
3931                                                         assert_eq!(*node_id, $node_a.node.get_our_node_id());
3932                                                         (*msg).clone()
3933                                                 },
3934                                                 _ => panic!("Unexpected event"),
3935                                         }, events.get(1).map(|e| e.clone()))
3936                                 };
3937                                 check_added_monitors!($node_b, 1);
3938                                 if $fail_backwards {
3939                                         assert!($node_a.node.get_and_clear_pending_events().is_empty());
3940                                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3941                                 }
3942                                 (extra_msg_option, bs_revoke_and_ack)
3943                         }
3944                 };
3945                 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr, true /* skip last step */, false /* return extra message */, true /* return last RAA */) => {
3946                         {
3947                                 check_added_monitors!($node_a, 0);
3948                                 assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3949                                 $node_a.node.handle_commitment_signed(&$node_b.node.get_our_node_id(), &$commitment_signed).unwrap();
3950                                 check_added_monitors!($node_a, 1);
3951                                 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
3952                                 assert!(extra_msg_option.is_none());
3953                                 bs_revoke_and_ack
3954                         }
3955                 };
3956                 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, true /* return extra message */) => {
3957                         {
3958                                 let (extra_msg_option, bs_revoke_and_ack) = commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true, true);
3959                                 $node_a.node.handle_revoke_and_ack(&$node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
3960                                 {
3961                                         let mut added_monitors = $node_a.chan_monitor.added_monitors.lock().unwrap();
3962                                         if $fail_backwards {
3963                                                 assert_eq!(added_monitors.len(), 2);
3964                                                 assert!(added_monitors[0].0 != added_monitors[1].0);
3965                                         } else {
3966                                                 assert_eq!(added_monitors.len(), 1);
3967                                         }
3968                                         added_monitors.clear();
3969                                 }
3970                                 extra_msg_option
3971                         }
3972                 };
3973                 ($node_a: expr, $node_b: expr, (), $fail_backwards: expr, true /* skip last step */, false /* no extra message */) => {
3974                         {
3975                                 assert!(commitment_signed_dance!($node_a, $node_b, (), $fail_backwards, true, true).is_none());
3976                         }
3977                 };
3978                 ($node_a: expr, $node_b: expr, $commitment_signed: expr, $fail_backwards: expr) => {
3979                         {
3980                                 commitment_signed_dance!($node_a, $node_b, $commitment_signed, $fail_backwards, true);
3981                                 if $fail_backwards {
3982                                         let channel_state = $node_a.node.channel_state.lock().unwrap();
3983                                         assert_eq!(channel_state.pending_msg_events.len(), 1);
3984                                         if let MessageSendEvent::UpdateHTLCs { ref node_id, .. } = channel_state.pending_msg_events[0] {
3985                                                 assert_ne!(*node_id, $node_b.node.get_our_node_id());
3986                                         } else { panic!("Unexpected event"); }
3987                                 } else {
3988                                         assert!($node_a.node.get_and_clear_pending_msg_events().is_empty());
3989                                 }
3990                         }
3991                 }
3992         }
3993
3994         macro_rules! get_payment_preimage_hash {
3995                 ($node: expr) => {
3996                         {
3997                                 let payment_preimage = [*$node.network_payment_count.borrow(); 32];
3998                                 *$node.network_payment_count.borrow_mut() += 1;
3999                                 let mut payment_hash = [0; 32];
4000                                 let mut sha = Sha256::new();
4001                                 sha.input(&payment_preimage[..]);
4002                                 sha.result(&mut payment_hash);
4003                                 (payment_preimage, payment_hash)
4004                         }
4005                 }
4006         }
4007
4008         fn send_along_route(origin_node: &Node, route: Route, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
4009                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(origin_node);
4010
4011                 let mut payment_event = {
4012                         origin_node.node.send_payment(route, our_payment_hash).unwrap();
4013                         check_added_monitors!(origin_node, 1);
4014
4015                         let mut events = origin_node.node.get_and_clear_pending_msg_events();
4016                         assert_eq!(events.len(), 1);
4017                         SendEvent::from_event(events.remove(0))
4018                 };
4019                 let mut prev_node = origin_node;
4020
4021                 for (idx, &node) in expected_route.iter().enumerate() {
4022                         assert_eq!(node.node.get_our_node_id(), payment_event.node_id);
4023
4024                         node.node.handle_update_add_htlc(&prev_node.node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4025                         check_added_monitors!(node, 0);
4026                         commitment_signed_dance!(node, prev_node, payment_event.commitment_msg, false);
4027
4028                         let events_1 = node.node.get_and_clear_pending_events();
4029                         assert_eq!(events_1.len(), 1);
4030                         match events_1[0] {
4031                                 Event::PendingHTLCsForwardable { .. } => { },
4032                                 _ => panic!("Unexpected event"),
4033                         };
4034
4035                         node.node.channel_state.lock().unwrap().next_forward = Instant::now();
4036                         node.node.process_pending_htlc_forwards();
4037
4038                         if idx == expected_route.len() - 1 {
4039                                 let events_2 = node.node.get_and_clear_pending_events();
4040                                 assert_eq!(events_2.len(), 1);
4041                                 match events_2[0] {
4042                                         Event::PaymentReceived { ref payment_hash, amt } => {
4043                                                 assert_eq!(our_payment_hash, *payment_hash);
4044                                                 assert_eq!(amt, recv_value);
4045                                         },
4046                                         _ => panic!("Unexpected event"),
4047                                 }
4048                         } else {
4049                                 let mut events_2 = node.node.get_and_clear_pending_msg_events();
4050                                 assert_eq!(events_2.len(), 1);
4051                                 check_added_monitors!(node, 1);
4052                                 payment_event = SendEvent::from_event(events_2.remove(0));
4053                                 assert_eq!(payment_event.msgs.len(), 1);
4054                         }
4055
4056                         prev_node = node;
4057                 }
4058
4059                 (our_payment_preimage, our_payment_hash)
4060         }
4061
4062         fn claim_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_preimage: [u8; 32]) {
4063                 assert!(expected_route.last().unwrap().node.claim_funds(our_payment_preimage));
4064                 check_added_monitors!(expected_route.last().unwrap(), 1);
4065
4066                 let mut next_msgs: Option<(msgs::UpdateFulfillHTLC, msgs::CommitmentSigned)> = None;
4067                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
4068                 macro_rules! get_next_msgs {
4069                         ($node: expr) => {
4070                                 {
4071                                         let events = $node.node.get_and_clear_pending_msg_events();
4072                                         assert_eq!(events.len(), 1);
4073                                         match events[0] {
4074                                                 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 } } => {
4075                                                         assert!(update_add_htlcs.is_empty());
4076                                                         assert_eq!(update_fulfill_htlcs.len(), 1);
4077                                                         assert!(update_fail_htlcs.is_empty());
4078                                                         assert!(update_fail_malformed_htlcs.is_empty());
4079                                                         assert!(update_fee.is_none());
4080                                                         expected_next_node = node_id.clone();
4081                                                         Some((update_fulfill_htlcs[0].clone(), commitment_signed.clone()))
4082                                                 },
4083                                                 _ => panic!("Unexpected event"),
4084                                         }
4085                                 }
4086                         }
4087                 }
4088
4089                 macro_rules! last_update_fulfill_dance {
4090                         ($node: expr, $prev_node: expr) => {
4091                                 {
4092                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
4093                                         check_added_monitors!($node, 0);
4094                                         assert!($node.node.get_and_clear_pending_msg_events().is_empty());
4095                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
4096                                 }
4097                         }
4098                 }
4099                 macro_rules! mid_update_fulfill_dance {
4100                         ($node: expr, $prev_node: expr, $new_msgs: expr) => {
4101                                 {
4102                                         $node.node.handle_update_fulfill_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
4103                                         check_added_monitors!($node, 1);
4104                                         let new_next_msgs = if $new_msgs {
4105                                                 get_next_msgs!($node)
4106                                         } else {
4107                                                 assert!($node.node.get_and_clear_pending_msg_events().is_empty());
4108                                                 None
4109                                         };
4110                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, false);
4111                                         next_msgs = new_next_msgs;
4112                                 }
4113                         }
4114                 }
4115
4116                 let mut prev_node = expected_route.last().unwrap();
4117                 for (idx, node) in expected_route.iter().rev().enumerate() {
4118                         assert_eq!(expected_next_node, node.node.get_our_node_id());
4119                         let update_next_msgs = !skip_last || idx != expected_route.len() - 1;
4120                         if next_msgs.is_some() {
4121                                 mid_update_fulfill_dance!(node, prev_node, update_next_msgs);
4122                         } else if update_next_msgs {
4123                                 next_msgs = get_next_msgs!(node);
4124                         } else {
4125                                 assert!(node.node.get_and_clear_pending_msg_events().is_empty());
4126                         }
4127                         if !skip_last && idx == expected_route.len() - 1 {
4128                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
4129                         }
4130
4131                         prev_node = node;
4132                 }
4133
4134                 if !skip_last {
4135                         last_update_fulfill_dance!(origin_node, expected_route.first().unwrap());
4136                         let events = origin_node.node.get_and_clear_pending_events();
4137                         assert_eq!(events.len(), 1);
4138                         match events[0] {
4139                                 Event::PaymentSent { payment_preimage } => {
4140                                         assert_eq!(payment_preimage, our_payment_preimage);
4141                                 },
4142                                 _ => panic!("Unexpected event"),
4143                         }
4144                 }
4145         }
4146
4147         fn claim_payment(origin_node: &Node, expected_route: &[&Node], our_payment_preimage: [u8; 32]) {
4148                 claim_payment_along_route(origin_node, expected_route, false, our_payment_preimage);
4149         }
4150
4151         const TEST_FINAL_CLTV: u32 = 32;
4152
4153         fn route_payment(origin_node: &Node, expected_route: &[&Node], recv_value: u64) -> ([u8; 32], [u8; 32]) {
4154                 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();
4155                 assert_eq!(route.hops.len(), expected_route.len());
4156                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
4157                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
4158                 }
4159
4160                 send_along_route(origin_node, route, expected_route, recv_value)
4161         }
4162
4163         fn route_over_limit(origin_node: &Node, expected_route: &[&Node], recv_value: u64) {
4164                 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();
4165                 assert_eq!(route.hops.len(), expected_route.len());
4166                 for (node, hop) in expected_route.iter().zip(route.hops.iter()) {
4167                         assert_eq!(hop.pubkey, node.node.get_our_node_id());
4168                 }
4169
4170                 let (_, our_payment_hash) = get_payment_preimage_hash!(origin_node);
4171
4172                 let err = origin_node.node.send_payment(route, our_payment_hash).err().unwrap();
4173                 match err {
4174                         APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
4175                         _ => panic!("Unknown error variants"),
4176                 };
4177         }
4178
4179         fn send_payment(origin: &Node, expected_route: &[&Node], recv_value: u64) {
4180                 let our_payment_preimage = route_payment(&origin, expected_route, recv_value).0;
4181                 claim_payment(&origin, expected_route, our_payment_preimage);
4182         }
4183
4184         fn fail_payment_along_route(origin_node: &Node, expected_route: &[&Node], skip_last: bool, our_payment_hash: [u8; 32]) {
4185                 assert!(expected_route.last().unwrap().node.fail_htlc_backwards(&our_payment_hash, PaymentFailReason::PreimageUnknown));
4186                 check_added_monitors!(expected_route.last().unwrap(), 1);
4187
4188                 let mut next_msgs: Option<(msgs::UpdateFailHTLC, msgs::CommitmentSigned)> = None;
4189                 macro_rules! update_fail_dance {
4190                         ($node: expr, $prev_node: expr, $last_node: expr) => {
4191                                 {
4192                                         $node.node.handle_update_fail_htlc(&$prev_node.node.get_our_node_id(), &next_msgs.as_ref().unwrap().0).unwrap();
4193                                         commitment_signed_dance!($node, $prev_node, next_msgs.as_ref().unwrap().1, !$last_node);
4194                                 }
4195                         }
4196                 }
4197
4198                 let mut expected_next_node = expected_route.last().unwrap().node.get_our_node_id();
4199                 let mut prev_node = expected_route.last().unwrap();
4200                 for (idx, node) in expected_route.iter().rev().enumerate() {
4201                         assert_eq!(expected_next_node, node.node.get_our_node_id());
4202                         if next_msgs.is_some() {
4203                                 // We may be the "last node" for the purpose of the commitment dance if we're
4204                                 // skipping the last node (implying it is disconnected) and we're the
4205                                 // second-to-last node!
4206                                 update_fail_dance!(node, prev_node, skip_last && idx == expected_route.len() - 1);
4207                         }
4208
4209                         let events = node.node.get_and_clear_pending_msg_events();
4210                         if !skip_last || idx != expected_route.len() - 1 {
4211                                 assert_eq!(events.len(), 1);
4212                                 match events[0] {
4213                                         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 } } => {
4214                                                 assert!(update_add_htlcs.is_empty());
4215                                                 assert!(update_fulfill_htlcs.is_empty());
4216                                                 assert_eq!(update_fail_htlcs.len(), 1);
4217                                                 assert!(update_fail_malformed_htlcs.is_empty());
4218                                                 assert!(update_fee.is_none());
4219                                                 expected_next_node = node_id.clone();
4220                                                 next_msgs = Some((update_fail_htlcs[0].clone(), commitment_signed.clone()));
4221                                         },
4222                                         _ => panic!("Unexpected event"),
4223                                 }
4224                         } else {
4225                                 assert!(events.is_empty());
4226                         }
4227                         if !skip_last && idx == expected_route.len() - 1 {
4228                                 assert_eq!(expected_next_node, origin_node.node.get_our_node_id());
4229                         }
4230
4231                         prev_node = node;
4232                 }
4233
4234                 if !skip_last {
4235                         update_fail_dance!(origin_node, expected_route.first().unwrap(), true);
4236
4237                         let events = origin_node.node.get_and_clear_pending_events();
4238                         assert_eq!(events.len(), 1);
4239                         match events[0] {
4240                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
4241                                         assert_eq!(payment_hash, our_payment_hash);
4242                                         assert!(rejected_by_dest);
4243                                 },
4244                                 _ => panic!("Unexpected event"),
4245                         }
4246                 }
4247         }
4248
4249         fn fail_payment(origin_node: &Node, expected_route: &[&Node], our_payment_hash: [u8; 32]) {
4250                 fail_payment_along_route(origin_node, expected_route, false, our_payment_hash);
4251         }
4252
4253         fn create_network(node_count: usize) -> Vec<Node> {
4254                 let mut nodes = Vec::new();
4255                 let mut rng = thread_rng();
4256                 let secp_ctx = Secp256k1::new();
4257                 let logger: Arc<Logger> = Arc::new(test_utils::TestLogger::new());
4258
4259                 let chan_count = Rc::new(RefCell::new(0));
4260                 let payment_count = Rc::new(RefCell::new(0));
4261
4262                 for _ in 0..node_count {
4263                         let feeest = Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 });
4264                         let chain_monitor = Arc::new(chaininterface::ChainWatchInterfaceUtil::new(Network::Testnet, Arc::clone(&logger)));
4265                         let tx_broadcaster = Arc::new(test_utils::TestBroadcaster{txn_broadcasted: Mutex::new(Vec::new())});
4266                         let mut seed = [0; 32];
4267                         rng.fill_bytes(&mut seed);
4268                         let keys_manager = Arc::new(keysinterface::KeysManager::new(&seed, Network::Testnet, Arc::clone(&logger)));
4269                         let chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(chain_monitor.clone(), tx_broadcaster.clone(), logger.clone()));
4270                         let mut config = UserConfig::new();
4271                         config.channel_options.announced_channel = true;
4272                         config.channel_limits.force_announced_channel_preference = false;
4273                         let node = ChannelManager::new(Network::Testnet, feeest.clone(), chan_monitor.clone(), chain_monitor.clone(), tx_broadcaster.clone(), Arc::clone(&logger), keys_manager.clone(), config).unwrap();
4274                         let router = Router::new(PublicKey::from_secret_key(&secp_ctx, &keys_manager.get_node_secret()), chain_monitor.clone(), Arc::clone(&logger));
4275                         nodes.push(Node { chain_monitor, tx_broadcaster, chan_monitor, node, router, node_seed: seed,
4276                                 network_payment_count: payment_count.clone(),
4277                                 network_chan_count: chan_count.clone(),
4278                         });
4279                 }
4280
4281                 nodes
4282         }
4283
4284         #[test]
4285         fn test_async_inbound_update_fee() {
4286                 let mut nodes = create_network(2);
4287                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4288                 let channel_id = chan.2;
4289
4290                 // balancing
4291                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4292
4293                 // A                                        B
4294                 // update_fee                            ->
4295                 // send (1) commitment_signed            -.
4296                 //                                       <- update_add_htlc/commitment_signed
4297                 // send (2) RAA (awaiting remote revoke) -.
4298                 // (1) commitment_signed is delivered    ->
4299                 //                                       .- send (3) RAA (awaiting remote revoke)
4300                 // (2) RAA is delivered                  ->
4301                 //                                       .- send (4) commitment_signed
4302                 //                                       <- (3) RAA is delivered
4303                 // send (5) commitment_signed            -.
4304                 //                                       <- (4) commitment_signed is delivered
4305                 // send (6) RAA                          -.
4306                 // (5) commitment_signed is delivered    ->
4307                 //                                       <- RAA
4308                 // (6) RAA is delivered                  ->
4309
4310                 // First nodes[0] generates an update_fee
4311                 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
4312                 check_added_monitors!(nodes[0], 1);
4313
4314                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4315                 assert_eq!(events_0.len(), 1);
4316                 let (update_msg, commitment_signed) = match events_0[0] { // (1)
4317                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
4318                                 (update_fee.as_ref(), commitment_signed)
4319                         },
4320                         _ => panic!("Unexpected event"),
4321                 };
4322
4323                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4324
4325                 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
4326                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4327                 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();
4328                 check_added_monitors!(nodes[1], 1);
4329
4330                 let payment_event = {
4331                         let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
4332                         assert_eq!(events_1.len(), 1);
4333                         SendEvent::from_event(events_1.remove(0))
4334                 };
4335                 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
4336                 assert_eq!(payment_event.msgs.len(), 1);
4337
4338                 // ...now when the messages get delivered everyone should be happy
4339                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4340                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
4341                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4342                 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
4343                 check_added_monitors!(nodes[0], 1);
4344
4345                 // deliver(1), generate (3):
4346                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4347                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4348                 // nodes[1] is awaiting nodes[0] revoke_and_ack so get_event_msg's assert(len == 1) passes
4349                 check_added_monitors!(nodes[1], 1);
4350
4351                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap(); // deliver (2)
4352                 let bs_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4353                 assert!(bs_update.update_add_htlcs.is_empty()); // (4)
4354                 assert!(bs_update.update_fulfill_htlcs.is_empty()); // (4)
4355                 assert!(bs_update.update_fail_htlcs.is_empty()); // (4)
4356                 assert!(bs_update.update_fail_malformed_htlcs.is_empty()); // (4)
4357                 assert!(bs_update.update_fee.is_none()); // (4)
4358                 check_added_monitors!(nodes[1], 1);
4359
4360                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap(); // deliver (3)
4361                 let as_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4362                 assert!(as_update.update_add_htlcs.is_empty()); // (5)
4363                 assert!(as_update.update_fulfill_htlcs.is_empty()); // (5)
4364                 assert!(as_update.update_fail_htlcs.is_empty()); // (5)
4365                 assert!(as_update.update_fail_malformed_htlcs.is_empty()); // (5)
4366                 assert!(as_update.update_fee.is_none()); // (5)
4367                 check_added_monitors!(nodes[0], 1);
4368
4369                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_update.commitment_signed).unwrap(); // deliver (4)
4370                 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4371                 // only (6) so get_event_msg's assert(len == 1) passes
4372                 check_added_monitors!(nodes[0], 1);
4373
4374                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_update.commitment_signed).unwrap(); // deliver (5)
4375                 let bs_second_revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4376                 check_added_monitors!(nodes[1], 1);
4377
4378                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
4379                 check_added_monitors!(nodes[0], 1);
4380
4381                 let events_2 = nodes[0].node.get_and_clear_pending_events();
4382                 assert_eq!(events_2.len(), 1);
4383                 match events_2[0] {
4384                         Event::PendingHTLCsForwardable {..} => {}, // If we actually processed we'd receive the payment
4385                         _ => panic!("Unexpected event"),
4386                 }
4387
4388                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap(); // deliver (6)
4389                 check_added_monitors!(nodes[1], 1);
4390         }
4391
4392         #[test]
4393         fn test_update_fee_unordered_raa() {
4394                 // Just the intro to the previous test followed by an out-of-order RAA (which caused a
4395                 // crash in an earlier version of the update_fee patch)
4396                 let mut nodes = create_network(2);
4397                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4398                 let channel_id = chan.2;
4399
4400                 // balancing
4401                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4402
4403                 // First nodes[0] generates an update_fee
4404                 nodes[0].node.update_fee(channel_id, get_feerate!(nodes[0], channel_id) + 20).unwrap();
4405                 check_added_monitors!(nodes[0], 1);
4406
4407                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4408                 assert_eq!(events_0.len(), 1);
4409                 let update_msg = match events_0[0] { // (1)
4410                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, .. }, .. } => {
4411                                 update_fee.as_ref()
4412                         },
4413                         _ => panic!("Unexpected event"),
4414                 };
4415
4416                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4417
4418                 // ...but before it's delivered, nodes[1] starts to send a payment back to nodes[0]...
4419                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4420                 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();
4421                 check_added_monitors!(nodes[1], 1);
4422
4423                 let payment_event = {
4424                         let mut events_1 = nodes[1].node.get_and_clear_pending_msg_events();
4425                         assert_eq!(events_1.len(), 1);
4426                         SendEvent::from_event(events_1.remove(0))
4427                 };
4428                 assert_eq!(payment_event.node_id, nodes[0].node.get_our_node_id());
4429                 assert_eq!(payment_event.msgs.len(), 1);
4430
4431                 // ...now when the messages get delivered everyone should be happy
4432                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
4433                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap(); // (2)
4434                 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4435                 // nodes[0] is awaiting nodes[1] revoke_and_ack so get_event_msg's assert(len == 1) passes
4436                 check_added_monitors!(nodes[0], 1);
4437
4438                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap(); // deliver (2)
4439                 check_added_monitors!(nodes[1], 1);
4440
4441                 // We can't continue, sadly, because our (1) now has a bogus signature
4442         }
4443
4444         #[test]
4445         fn test_multi_flight_update_fee() {
4446                 let nodes = create_network(2);
4447                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4448                 let channel_id = chan.2;
4449
4450                 // A                                        B
4451                 // update_fee/commitment_signed          ->
4452                 //                                       .- send (1) RAA and (2) commitment_signed
4453                 // update_fee (never committed)          ->
4454                 // (3) update_fee                        ->
4455                 // We have to manually generate the above update_fee, it is allowed by the protocol but we
4456                 // don't track which updates correspond to which revoke_and_ack responses so we're in
4457                 // AwaitingRAA mode and will not generate the update_fee yet.
4458                 //                                       <- (1) RAA delivered
4459                 // (3) is generated and send (4) CS      -.
4460                 // Note that A cannot generate (4) prior to (1) being delivered as it otherwise doesn't
4461                 // know the per_commitment_point to use for it.
4462                 //                                       <- (2) commitment_signed delivered
4463                 // revoke_and_ack                        ->
4464                 //                                          B should send no response here
4465                 // (4) commitment_signed delivered       ->
4466                 //                                       <- RAA/commitment_signed delivered
4467                 // revoke_and_ack                        ->
4468
4469                 // First nodes[0] generates an update_fee
4470                 let initial_feerate = get_feerate!(nodes[0], channel_id);
4471                 nodes[0].node.update_fee(channel_id, initial_feerate + 20).unwrap();
4472                 check_added_monitors!(nodes[0], 1);
4473
4474                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4475                 assert_eq!(events_0.len(), 1);
4476                 let (update_msg_1, commitment_signed_1) = match events_0[0] { // (1)
4477                         MessageSendEvent::UpdateHTLCs { updates: msgs::CommitmentUpdate { ref update_fee, ref commitment_signed, .. }, .. } => {
4478                                 (update_fee.as_ref().unwrap(), commitment_signed)
4479                         },
4480                         _ => panic!("Unexpected event"),
4481                 };
4482
4483                 // Deliver first update_fee/commitment_signed pair, generating (1) and (2):
4484                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg_1).unwrap();
4485                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed_1).unwrap();
4486                 let (bs_revoke_msg, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4487                 check_added_monitors!(nodes[1], 1);
4488
4489                 // nodes[0] is awaiting a revoke from nodes[1] before it will create a new commitment
4490                 // transaction:
4491                 nodes[0].node.update_fee(channel_id, initial_feerate + 40).unwrap();
4492                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4493                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4494
4495                 // Create the (3) update_fee message that nodes[0] will generate before it does...
4496                 let mut update_msg_2 = msgs::UpdateFee {
4497                         channel_id: update_msg_1.channel_id.clone(),
4498                         feerate_per_kw: (initial_feerate + 30) as u32,
4499                 };
4500
4501                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
4502
4503                 update_msg_2.feerate_per_kw = (initial_feerate + 40) as u32;
4504                 // Deliver (3)
4505                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg_2).unwrap();
4506
4507                 // Deliver (1), generating (3) and (4)
4508                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_msg).unwrap();
4509                 let as_second_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4510                 check_added_monitors!(nodes[0], 1);
4511                 assert!(as_second_update.update_add_htlcs.is_empty());
4512                 assert!(as_second_update.update_fulfill_htlcs.is_empty());
4513                 assert!(as_second_update.update_fail_htlcs.is_empty());
4514                 assert!(as_second_update.update_fail_malformed_htlcs.is_empty());
4515                 // Check that the update_fee newly generated matches what we delivered:
4516                 assert_eq!(as_second_update.update_fee.as_ref().unwrap().channel_id, update_msg_2.channel_id);
4517                 assert_eq!(as_second_update.update_fee.as_ref().unwrap().feerate_per_kw, update_msg_2.feerate_per_kw);
4518
4519                 // Deliver (2) commitment_signed
4520                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
4521                 let as_revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4522                 check_added_monitors!(nodes[0], 1);
4523                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4524
4525                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_msg).unwrap();
4526                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4527                 check_added_monitors!(nodes[1], 1);
4528
4529                 // Delever (4)
4530                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_second_update.commitment_signed).unwrap();
4531                 let (bs_second_revoke, bs_second_commitment) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4532                 check_added_monitors!(nodes[1], 1);
4533
4534                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke).unwrap();
4535                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4536                 check_added_monitors!(nodes[0], 1);
4537
4538                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment).unwrap();
4539                 let as_second_revoke = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4540                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4541                 check_added_monitors!(nodes[0], 1);
4542
4543                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_second_revoke).unwrap();
4544                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4545                 check_added_monitors!(nodes[1], 1);
4546         }
4547
4548         #[test]
4549         fn test_update_fee_vanilla() {
4550                 let nodes = create_network(2);
4551                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4552                 let channel_id = chan.2;
4553
4554                 let feerate = get_feerate!(nodes[0], channel_id);
4555                 nodes[0].node.update_fee(channel_id, feerate+25).unwrap();
4556                 check_added_monitors!(nodes[0], 1);
4557
4558                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4559                 assert_eq!(events_0.len(), 1);
4560                 let (update_msg, commitment_signed) = match events_0[0] {
4561                                 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 } } => {
4562                                 (update_fee.as_ref(), commitment_signed)
4563                         },
4564                         _ => panic!("Unexpected event"),
4565                 };
4566                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4567
4568                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4569                 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4570                 check_added_monitors!(nodes[1], 1);
4571
4572                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4573                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4574                 check_added_monitors!(nodes[0], 1);
4575
4576                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
4577                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4578                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4579                 check_added_monitors!(nodes[0], 1);
4580
4581                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4582                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4583                 check_added_monitors!(nodes[1], 1);
4584         }
4585
4586         #[test]
4587         fn test_update_fee_that_funder_cannot_afford() {
4588                 let nodes = create_network(2);
4589                 let channel_value = 1888;
4590                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, channel_value, 700000);
4591                 let channel_id = chan.2;
4592
4593                 let feerate = 260;
4594                 nodes[0].node.update_fee(channel_id, feerate).unwrap();
4595                 check_added_monitors!(nodes[0], 1);
4596                 let update_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4597
4598                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update_msg.update_fee.unwrap()).unwrap();
4599
4600                 commitment_signed_dance!(nodes[1], nodes[0], update_msg.commitment_signed, false);
4601
4602                 //Confirm that the new fee based on the last local commitment txn is what we expected based on the feerate of 260 set above.
4603                 //This value results in a fee that is exactly what the funder can afford (277 sat + 1000 sat channel reserve)
4604                 {
4605                         let chan_lock = nodes[1].node.channel_state.lock().unwrap();
4606                         let chan = chan_lock.by_id.get(&channel_id).unwrap();
4607
4608                         //We made sure neither party's funds are below the dust limit so -2 non-HTLC txns from number of outputs
4609                         let num_htlcs = chan.last_local_commitment_txn[0].output.len() - 2;
4610                         let total_fee: u64 = feerate * (COMMITMENT_TX_BASE_WEIGHT + (num_htlcs as u64) * COMMITMENT_TX_WEIGHT_PER_HTLC) / 1000;
4611                         let mut actual_fee = chan.last_local_commitment_txn[0].output.iter().fold(0, |acc, output| acc + output.value);
4612                         actual_fee = channel_value - actual_fee;
4613                         assert_eq!(total_fee, actual_fee);
4614                 } //drop the mutex
4615
4616                 //Add 2 to the previous fee rate to the final fee increases by 1 (with no HTLCs the fee is essentially
4617                 //fee_rate*(724/1000) so the increment of 1*0.724 is rounded back down)
4618                 nodes[0].node.update_fee(channel_id, feerate+2).unwrap();
4619                 check_added_monitors!(nodes[0], 1);
4620
4621                 let update2_msg = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4622
4623                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &update2_msg.update_fee.unwrap()).unwrap();
4624
4625                 //While producing the commitment_signed response after handling a received update_fee request the
4626                 //check to see if the funder, who sent the update_fee request, can afford the new fee (funder_balance >= fee+channel_reserve)
4627                 //Should produce and error.
4628                 let err = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &update2_msg.commitment_signed).unwrap_err();
4629
4630                 assert!(match err.err {
4631                         "Funding remote cannot afford proposed new fee" => true,
4632                         _ => false,
4633                 });
4634
4635                 //clear the message we could not handle
4636                 nodes[1].node.get_and_clear_pending_msg_events();
4637         }
4638
4639         #[test]
4640         fn test_update_fee_with_fundee_update_add_htlc() {
4641                 let mut nodes = create_network(2);
4642                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4643                 let channel_id = chan.2;
4644
4645                 // balancing
4646                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
4647
4648                 let feerate = get_feerate!(nodes[0], channel_id);
4649                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
4650                 check_added_monitors!(nodes[0], 1);
4651
4652                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4653                 assert_eq!(events_0.len(), 1);
4654                 let (update_msg, commitment_signed) = match events_0[0] {
4655                                 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 } } => {
4656                                 (update_fee.as_ref(), commitment_signed)
4657                         },
4658                         _ => panic!("Unexpected event"),
4659                 };
4660                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4661                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4662                 let (revoke_msg, commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4663                 check_added_monitors!(nodes[1], 1);
4664
4665                 let route = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 800000, TEST_FINAL_CLTV).unwrap();
4666
4667                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[1]);
4668
4669                 // nothing happens since node[1] is in AwaitingRemoteRevoke
4670                 nodes[1].node.send_payment(route, our_payment_hash).unwrap();
4671                 {
4672                         let mut added_monitors = nodes[0].chan_monitor.added_monitors.lock().unwrap();
4673                         assert_eq!(added_monitors.len(), 0);
4674                         added_monitors.clear();
4675                 }
4676                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
4677                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4678                 // node[1] has nothing to do
4679
4680                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4681                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4682                 check_added_monitors!(nodes[0], 1);
4683
4684                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
4685                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4686                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4687                 check_added_monitors!(nodes[0], 1);
4688                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4689                 check_added_monitors!(nodes[1], 1);
4690                 // AwaitingRemoteRevoke ends here
4691
4692                 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4693                 assert_eq!(commitment_update.update_add_htlcs.len(), 1);
4694                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), 0);
4695                 assert_eq!(commitment_update.update_fail_htlcs.len(), 0);
4696                 assert_eq!(commitment_update.update_fail_malformed_htlcs.len(), 0);
4697                 assert_eq!(commitment_update.update_fee.is_none(), true);
4698
4699                 nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &commitment_update.update_add_htlcs[0]).unwrap();
4700                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4701                 check_added_monitors!(nodes[0], 1);
4702                 let (revoke, commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4703
4704                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke).unwrap();
4705                 check_added_monitors!(nodes[1], 1);
4706                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4707
4708                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &commitment_signed).unwrap();
4709                 check_added_monitors!(nodes[1], 1);
4710                 let revoke = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4711                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4712
4713                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke).unwrap();
4714                 check_added_monitors!(nodes[0], 1);
4715                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4716
4717                 let events = nodes[0].node.get_and_clear_pending_events();
4718                 assert_eq!(events.len(), 1);
4719                 match events[0] {
4720                         Event::PendingHTLCsForwardable { .. } => { },
4721                         _ => panic!("Unexpected event"),
4722                 };
4723                 nodes[0].node.channel_state.lock().unwrap().next_forward = Instant::now();
4724                 nodes[0].node.process_pending_htlc_forwards();
4725
4726                 let events = nodes[0].node.get_and_clear_pending_events();
4727                 assert_eq!(events.len(), 1);
4728                 match events[0] {
4729                         Event::PaymentReceived { .. } => { },
4730                         _ => panic!("Unexpected event"),
4731                 };
4732
4733                 claim_payment(&nodes[1], &vec!(&nodes[0])[..], our_payment_preimage);
4734
4735                 send_payment(&nodes[1], &vec!(&nodes[0])[..], 800000);
4736                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 800000);
4737                 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
4738         }
4739
4740         #[test]
4741         fn test_update_fee() {
4742                 let nodes = create_network(2);
4743                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
4744                 let channel_id = chan.2;
4745
4746                 // A                                        B
4747                 // (1) update_fee/commitment_signed      ->
4748                 //                                       <- (2) revoke_and_ack
4749                 //                                       .- send (3) commitment_signed
4750                 // (4) update_fee/commitment_signed      ->
4751                 //                                       .- send (5) revoke_and_ack (no CS as we're awaiting a revoke)
4752                 //                                       <- (3) commitment_signed delivered
4753                 // send (6) revoke_and_ack               -.
4754                 //                                       <- (5) deliver revoke_and_ack
4755                 // (6) deliver revoke_and_ack            ->
4756                 //                                       .- send (7) commitment_signed in response to (4)
4757                 //                                       <- (7) deliver commitment_signed
4758                 // revoke_and_ack                        ->
4759
4760                 // Create and deliver (1)...
4761                 let feerate = get_feerate!(nodes[0], channel_id);
4762                 nodes[0].node.update_fee(channel_id, feerate+20).unwrap();
4763                 check_added_monitors!(nodes[0], 1);
4764
4765                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4766                 assert_eq!(events_0.len(), 1);
4767                 let (update_msg, commitment_signed) = match events_0[0] {
4768                                 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 } } => {
4769                                 (update_fee.as_ref(), commitment_signed)
4770                         },
4771                         _ => panic!("Unexpected event"),
4772                 };
4773                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4774
4775                 // Generate (2) and (3):
4776                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4777                 let (revoke_msg, commitment_signed_0) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4778                 check_added_monitors!(nodes[1], 1);
4779
4780                 // Deliver (2):
4781                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4782                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4783                 check_added_monitors!(nodes[0], 1);
4784
4785                 // Create and deliver (4)...
4786                 nodes[0].node.update_fee(channel_id, feerate+30).unwrap();
4787                 check_added_monitors!(nodes[0], 1);
4788                 let events_0 = nodes[0].node.get_and_clear_pending_msg_events();
4789                 assert_eq!(events_0.len(), 1);
4790                 let (update_msg, commitment_signed) = match events_0[0] {
4791                                 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 } } => {
4792                                 (update_fee.as_ref(), commitment_signed)
4793                         },
4794                         _ => panic!("Unexpected event"),
4795                 };
4796
4797                 nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), update_msg.unwrap()).unwrap();
4798                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), commitment_signed).unwrap();
4799                 check_added_monitors!(nodes[1], 1);
4800                 // ... creating (5)
4801                 let revoke_msg = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
4802                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4803
4804                 // Handle (3), creating (6):
4805                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed_0).unwrap();
4806                 check_added_monitors!(nodes[0], 1);
4807                 let revoke_msg_0 = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4808                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4809
4810                 // Deliver (5):
4811                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &revoke_msg).unwrap();
4812                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4813                 check_added_monitors!(nodes[0], 1);
4814
4815                 // Deliver (6), creating (7):
4816                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg_0).unwrap();
4817                 let commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4818                 assert!(commitment_update.update_add_htlcs.is_empty());
4819                 assert!(commitment_update.update_fulfill_htlcs.is_empty());
4820                 assert!(commitment_update.update_fail_htlcs.is_empty());
4821                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
4822                 assert!(commitment_update.update_fee.is_none());
4823                 check_added_monitors!(nodes[1], 1);
4824
4825                 // Deliver (7)
4826                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
4827                 check_added_monitors!(nodes[0], 1);
4828                 let revoke_msg = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
4829                 // No commitment_signed so get_event_msg's assert(len == 1) passes
4830
4831                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &revoke_msg).unwrap();
4832                 check_added_monitors!(nodes[1], 1);
4833                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4834
4835                 assert_eq!(get_feerate!(nodes[0], channel_id), feerate + 30);
4836                 assert_eq!(get_feerate!(nodes[1], channel_id), feerate + 30);
4837                 close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true);
4838         }
4839
4840         #[test]
4841         fn pre_funding_lock_shutdown_test() {
4842                 // Test sending a shutdown prior to funding_locked after funding generation
4843                 let nodes = create_network(2);
4844                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 8000000, 0);
4845                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
4846                 nodes[0].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
4847                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx; 1], &[1; 1]);
4848
4849                 nodes[0].node.close_channel(&OutPoint::new(tx.txid(), 0).to_channel_id()).unwrap();
4850                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4851                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4852                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4853                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4854
4855                 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
4856                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
4857                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4858                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4859                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4860                 assert!(node_0_none.is_none());
4861
4862                 assert!(nodes[0].node.list_channels().is_empty());
4863                 assert!(nodes[1].node.list_channels().is_empty());
4864         }
4865
4866         #[test]
4867         fn updates_shutdown_wait() {
4868                 // Test sending a shutdown with outstanding updates pending
4869                 let mut nodes = create_network(3);
4870                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4871                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4872                 let route_1 = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4873                 let route_2 = nodes[1].router.get_route(&nodes[0].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4874
4875                 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
4876
4877                 nodes[0].node.close_channel(&chan_1.2).unwrap();
4878                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4879                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4880                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4881                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4882
4883                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
4884                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4885
4886                 let (_, payment_hash) = get_payment_preimage_hash!(nodes[0]);
4887                 if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route_1, payment_hash) {}
4888                 else { panic!("New sends should fail!") };
4889                 if let Err(APIError::ChannelUnavailable {..}) = nodes[1].node.send_payment(route_2, payment_hash) {}
4890                 else { panic!("New sends should fail!") };
4891
4892                 assert!(nodes[2].node.claim_funds(our_payment_preimage));
4893                 check_added_monitors!(nodes[2], 1);
4894                 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
4895                 assert!(updates.update_add_htlcs.is_empty());
4896                 assert!(updates.update_fail_htlcs.is_empty());
4897                 assert!(updates.update_fail_malformed_htlcs.is_empty());
4898                 assert!(updates.update_fee.is_none());
4899                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
4900                 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
4901                 check_added_monitors!(nodes[1], 1);
4902                 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4903                 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
4904
4905                 assert!(updates_2.update_add_htlcs.is_empty());
4906                 assert!(updates_2.update_fail_htlcs.is_empty());
4907                 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
4908                 assert!(updates_2.update_fee.is_none());
4909                 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
4910                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
4911                 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
4912
4913                 let events = nodes[0].node.get_and_clear_pending_events();
4914                 assert_eq!(events.len(), 1);
4915                 match events[0] {
4916                         Event::PaymentSent { ref payment_preimage } => {
4917                                 assert_eq!(our_payment_preimage, *payment_preimage);
4918                         },
4919                         _ => panic!("Unexpected event"),
4920                 }
4921
4922                 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
4923                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
4924                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4925                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4926                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4927                 assert!(node_0_none.is_none());
4928
4929                 assert!(nodes[0].node.list_channels().is_empty());
4930
4931                 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4932                 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
4933                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
4934                 assert!(nodes[1].node.list_channels().is_empty());
4935                 assert!(nodes[2].node.list_channels().is_empty());
4936         }
4937
4938         #[test]
4939         fn htlc_fail_async_shutdown() {
4940                 // Test HTLCs fail if shutdown starts even if messages are delivered out-of-order
4941                 let mut nodes = create_network(3);
4942                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
4943                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
4944
4945                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &[], 100000, TEST_FINAL_CLTV).unwrap();
4946                 let (_, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
4947                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
4948                 check_added_monitors!(nodes[0], 1);
4949                 let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
4950                 assert_eq!(updates.update_add_htlcs.len(), 1);
4951                 assert!(updates.update_fulfill_htlcs.is_empty());
4952                 assert!(updates.update_fail_htlcs.is_empty());
4953                 assert!(updates.update_fail_malformed_htlcs.is_empty());
4954                 assert!(updates.update_fee.is_none());
4955
4956                 nodes[1].node.close_channel(&chan_1.2).unwrap();
4957                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
4958                 nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
4959                 let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
4960
4961                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &updates.update_add_htlcs[0]).unwrap();
4962                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
4963                 check_added_monitors!(nodes[1], 1);
4964                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
4965                 commitment_signed_dance!(nodes[1], nodes[0], (), false, true, false);
4966
4967                 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
4968                 assert!(updates_2.update_add_htlcs.is_empty());
4969                 assert!(updates_2.update_fulfill_htlcs.is_empty());
4970                 assert_eq!(updates_2.update_fail_htlcs.len(), 1);
4971                 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
4972                 assert!(updates_2.update_fee.is_none());
4973
4974                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fail_htlcs[0]).unwrap();
4975                 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
4976
4977                 let events = nodes[0].node.get_and_clear_pending_events();
4978                 assert_eq!(events.len(), 1);
4979                 match events[0] {
4980                         Event::PaymentFailed { ref payment_hash, ref rejected_by_dest } => {
4981                                 assert_eq!(our_payment_hash, *payment_hash);
4982                                 assert!(!rejected_by_dest);
4983                         },
4984                         _ => panic!("Unexpected event"),
4985                 }
4986
4987                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
4988                 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
4989                 nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
4990                 let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
4991                 nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
4992                 let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
4993                 assert!(node_0_none.is_none());
4994
4995                 assert!(nodes[0].node.list_channels().is_empty());
4996
4997                 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
4998                 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
4999                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
5000                 assert!(nodes[1].node.list_channels().is_empty());
5001                 assert!(nodes[2].node.list_channels().is_empty());
5002         }
5003
5004         fn do_test_shutdown_rebroadcast(recv_count: u8) {
5005                 // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
5006                 // messages delivered prior to disconnect
5007                 let nodes = create_network(3);
5008                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5009                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5010
5011                 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 100000);
5012
5013                 nodes[1].node.close_channel(&chan_1.2).unwrap();
5014                 let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
5015                 if recv_count > 0 {
5016                         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
5017                         let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
5018                         if recv_count > 1 {
5019                                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
5020                         }
5021                 }
5022
5023                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5024                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5025
5026                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5027                 let node_0_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
5028                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5029                 let node_1_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
5030
5031                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_reestablish).unwrap();
5032                 let node_1_2nd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
5033                 assert!(node_1_shutdown == node_1_2nd_shutdown);
5034
5035                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_reestablish).unwrap();
5036                 let node_0_2nd_shutdown = if recv_count > 0 {
5037                         let node_0_2nd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
5038                         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
5039                         node_0_2nd_shutdown
5040                 } else {
5041                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5042                         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_2nd_shutdown).unwrap();
5043                         get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id())
5044                 };
5045                 nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_2nd_shutdown).unwrap();
5046
5047                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5048                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5049
5050                 assert!(nodes[2].node.claim_funds(our_payment_preimage));
5051                 check_added_monitors!(nodes[2], 1);
5052                 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
5053                 assert!(updates.update_add_htlcs.is_empty());
5054                 assert!(updates.update_fail_htlcs.is_empty());
5055                 assert!(updates.update_fail_malformed_htlcs.is_empty());
5056                 assert!(updates.update_fee.is_none());
5057                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
5058                 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
5059                 check_added_monitors!(nodes[1], 1);
5060                 let updates_2 = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5061                 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
5062
5063                 assert!(updates_2.update_add_htlcs.is_empty());
5064                 assert!(updates_2.update_fail_htlcs.is_empty());
5065                 assert!(updates_2.update_fail_malformed_htlcs.is_empty());
5066                 assert!(updates_2.update_fee.is_none());
5067                 assert_eq!(updates_2.update_fulfill_htlcs.len(), 1);
5068                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates_2.update_fulfill_htlcs[0]).unwrap();
5069                 commitment_signed_dance!(nodes[0], nodes[1], updates_2.commitment_signed, false, true);
5070
5071                 let events = nodes[0].node.get_and_clear_pending_events();
5072                 assert_eq!(events.len(), 1);
5073                 match events[0] {
5074                         Event::PaymentSent { ref payment_preimage } => {
5075                                 assert_eq!(our_payment_preimage, *payment_preimage);
5076                         },
5077                         _ => panic!("Unexpected event"),
5078                 }
5079
5080                 let node_0_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
5081                 if recv_count > 0 {
5082                         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_closing_signed).unwrap();
5083                         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
5084                         assert!(node_1_closing_signed.is_some());
5085                 }
5086
5087                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
5088                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
5089
5090                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
5091                 let node_0_2nd_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
5092                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
5093                 if recv_count == 0 {
5094                         // If all closing_signeds weren't delivered we can just resume where we left off...
5095                         let node_1_2nd_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
5096
5097                         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &node_1_2nd_reestablish).unwrap();
5098                         let node_0_3rd_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
5099                         assert!(node_0_2nd_shutdown == node_0_3rd_shutdown);
5100
5101                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish).unwrap();
5102                         let node_1_3rd_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
5103                         assert!(node_1_3rd_shutdown == node_1_2nd_shutdown);
5104
5105                         nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_3rd_shutdown).unwrap();
5106                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5107
5108                         nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_3rd_shutdown).unwrap();
5109                         let node_0_2nd_closing_signed = get_event_msg!(nodes[0], MessageSendEvent::SendClosingSigned, nodes[1].node.get_our_node_id());
5110                         assert!(node_0_closing_signed == node_0_2nd_closing_signed);
5111
5112                         nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), &node_0_2nd_closing_signed).unwrap();
5113                         let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
5114                         nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
5115                         let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
5116                         assert!(node_0_none.is_none());
5117                 } else {
5118                         // If one node, however, received + responded with an identical closing_signed we end
5119                         // up erroring and node[0] will try to broadcast its own latest commitment transaction.
5120                         // There isn't really anything better we can do simply, but in the future we might
5121                         // explore storing a set of recently-closed channels that got disconnected during
5122                         // closing_signed and avoiding broadcasting local commitment txn for some timeout to
5123                         // give our counterparty enough time to (potentially) broadcast a cooperative closing
5124                         // transaction.
5125                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5126
5127                         if let Err(msgs::HandleError{action: Some(msgs::ErrorAction::SendErrorMessage{msg}), ..}) =
5128                                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &node_0_2nd_reestablish) {
5129                                 nodes[0].node.handle_error(&nodes[1].node.get_our_node_id(), &msg);
5130                                 let msgs::ErrorMessage {ref channel_id, ..} = msg;
5131                                 assert_eq!(*channel_id, chan_1.2);
5132                         } else { panic!("Needed SendErrorMessage close"); }
5133
5134                         // get_closing_signed_broadcast usually eats the BroadcastChannelUpdate for us and
5135                         // checks it, but in this case nodes[0] didn't ever get a chance to receive a
5136                         // closing_signed so we do it ourselves
5137                         let events = nodes[0].node.get_and_clear_pending_msg_events();
5138                         assert_eq!(events.len(), 1);
5139                         match events[0] {
5140                                 MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5141                                         assert_eq!(msg.contents.flags & 2, 2);
5142                                 },
5143                                 _ => panic!("Unexpected event"),
5144                         }
5145                 }
5146
5147                 assert!(nodes[0].node.list_channels().is_empty());
5148
5149                 assert_eq!(nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().len(), 1);
5150                 nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap().clear();
5151                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, true);
5152                 assert!(nodes[1].node.list_channels().is_empty());
5153                 assert!(nodes[2].node.list_channels().is_empty());
5154         }
5155
5156         #[test]
5157         fn test_shutdown_rebroadcast() {
5158                 do_test_shutdown_rebroadcast(0);
5159                 do_test_shutdown_rebroadcast(1);
5160                 do_test_shutdown_rebroadcast(2);
5161         }
5162
5163         #[test]
5164         fn fake_network_test() {
5165                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
5166                 // tests that payments get routed and transactions broadcast in semi-reasonable ways.
5167                 let nodes = create_network(4);
5168
5169                 // Create some initial channels
5170                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5171                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5172                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
5173
5174                 // Rebalance the network a bit by relaying one payment through all the channels...
5175                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5176                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5177                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5178                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 8000000);
5179
5180                 // Send some more payments
5181                 send_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 1000000);
5182                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1], &nodes[0])[..], 1000000);
5183                 send_payment(&nodes[3], &vec!(&nodes[2], &nodes[1])[..], 1000000);
5184
5185                 // Test failure packets
5186                 let payment_hash_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], 1000000).1;
5187                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3])[..], payment_hash_1);
5188
5189                 // Add a new channel that skips 3
5190                 let chan_4 = create_announced_chan_between_nodes(&nodes, 1, 3);
5191
5192                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 1000000);
5193                 send_payment(&nodes[2], &vec!(&nodes[3])[..], 1000000);
5194                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5195                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5196                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5197                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5198                 send_payment(&nodes[1], &vec!(&nodes[3])[..], 8000000);
5199
5200                 // Do some rebalance loop payments, simultaneously
5201                 let mut hops = Vec::with_capacity(3);
5202                 hops.push(RouteHop {
5203                         pubkey: nodes[2].node.get_our_node_id(),
5204                         short_channel_id: chan_2.0.contents.short_channel_id,
5205                         fee_msat: 0,
5206                         cltv_expiry_delta: chan_3.0.contents.cltv_expiry_delta as u32
5207                 });
5208                 hops.push(RouteHop {
5209                         pubkey: nodes[3].node.get_our_node_id(),
5210                         short_channel_id: chan_3.0.contents.short_channel_id,
5211                         fee_msat: 0,
5212                         cltv_expiry_delta: chan_4.1.contents.cltv_expiry_delta as u32
5213                 });
5214                 hops.push(RouteHop {
5215                         pubkey: nodes[1].node.get_our_node_id(),
5216                         short_channel_id: chan_4.0.contents.short_channel_id,
5217                         fee_msat: 1000000,
5218                         cltv_expiry_delta: TEST_FINAL_CLTV,
5219                 });
5220                 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;
5221                 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;
5222                 let payment_preimage_1 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[2], &nodes[3], &nodes[1])[..], 1000000).0;
5223
5224                 let mut hops = Vec::with_capacity(3);
5225                 hops.push(RouteHop {
5226                         pubkey: nodes[3].node.get_our_node_id(),
5227                         short_channel_id: chan_4.0.contents.short_channel_id,
5228                         fee_msat: 0,
5229                         cltv_expiry_delta: chan_3.1.contents.cltv_expiry_delta as u32
5230                 });
5231                 hops.push(RouteHop {
5232                         pubkey: nodes[2].node.get_our_node_id(),
5233                         short_channel_id: chan_3.0.contents.short_channel_id,
5234                         fee_msat: 0,
5235                         cltv_expiry_delta: chan_2.1.contents.cltv_expiry_delta as u32
5236                 });
5237                 hops.push(RouteHop {
5238                         pubkey: nodes[1].node.get_our_node_id(),
5239                         short_channel_id: chan_2.0.contents.short_channel_id,
5240                         fee_msat: 1000000,
5241                         cltv_expiry_delta: TEST_FINAL_CLTV,
5242                 });
5243                 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;
5244                 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;
5245                 let payment_hash_2 = send_along_route(&nodes[1], Route { hops }, &vec!(&nodes[3], &nodes[2], &nodes[1])[..], 1000000).1;
5246
5247                 // Claim the rebalances...
5248                 fail_payment(&nodes[1], &vec!(&nodes[3], &nodes[2], &nodes[1])[..], payment_hash_2);
5249                 claim_payment(&nodes[1], &vec!(&nodes[2], &nodes[3], &nodes[1])[..], payment_preimage_1);
5250
5251                 // Add a duplicate new channel from 2 to 4
5252                 let chan_5 = create_announced_chan_between_nodes(&nodes, 1, 3);
5253
5254                 // Send some payments across both channels
5255                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
5256                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
5257                 let payment_preimage_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000).0;
5258
5259                 route_over_limit(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], 3000000);
5260
5261                 //TODO: Test that routes work again here as we've been notified that the channel is full
5262
5263                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_3);
5264                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_4);
5265                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[3])[..], payment_preimage_5);
5266
5267                 // Close down the channels...
5268                 close_channel(&nodes[0], &nodes[1], &chan_1.2, chan_1.3, true);
5269                 close_channel(&nodes[1], &nodes[2], &chan_2.2, chan_2.3, false);
5270                 close_channel(&nodes[2], &nodes[3], &chan_3.2, chan_3.3, true);
5271                 close_channel(&nodes[1], &nodes[3], &chan_4.2, chan_4.3, false);
5272                 close_channel(&nodes[1], &nodes[3], &chan_5.2, chan_5.3, false);
5273         }
5274
5275         #[test]
5276         fn duplicate_htlc_test() {
5277                 // Test that we accept duplicate payment_hash HTLCs across the network and that
5278                 // claiming/failing them are all separate and don't effect each other
5279                 let mut nodes = create_network(6);
5280
5281                 // Create some initial channels to route via 3 to 4/5 from 0/1/2
5282                 create_announced_chan_between_nodes(&nodes, 0, 3);
5283                 create_announced_chan_between_nodes(&nodes, 1, 3);
5284                 create_announced_chan_between_nodes(&nodes, 2, 3);
5285                 create_announced_chan_between_nodes(&nodes, 3, 4);
5286                 create_announced_chan_between_nodes(&nodes, 3, 5);
5287
5288                 let (payment_preimage, payment_hash) = route_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], 1000000);
5289
5290                 *nodes[0].network_payment_count.borrow_mut() -= 1;
5291                 assert_eq!(route_payment(&nodes[1], &vec!(&nodes[3])[..], 1000000).0, payment_preimage);
5292
5293                 *nodes[0].network_payment_count.borrow_mut() -= 1;
5294                 assert_eq!(route_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], 1000000).0, payment_preimage);
5295
5296                 claim_payment(&nodes[0], &vec!(&nodes[3], &nodes[4])[..], payment_preimage);
5297                 fail_payment(&nodes[2], &vec!(&nodes[3], &nodes[5])[..], payment_hash);
5298                 claim_payment(&nodes[1], &vec!(&nodes[3])[..], payment_preimage);
5299         }
5300
5301         #[derive(PartialEq)]
5302         enum HTLCType { NONE, TIMEOUT, SUCCESS }
5303         /// Tests that the given node has broadcast transactions for the given Channel
5304         ///
5305         /// First checks that the latest local commitment tx has been broadcast, unless an explicit
5306         /// commitment_tx is provided, which may be used to test that a remote commitment tx was
5307         /// broadcast and the revoked outputs were claimed.
5308         ///
5309         /// Next tests that there is (or is not) a transaction that spends the commitment transaction
5310         /// that appears to be the type of HTLC transaction specified in has_htlc_tx.
5311         ///
5312         /// All broadcast transactions must be accounted for in one of the above three types of we'll
5313         /// also fail.
5314         fn test_txn_broadcast(node: &Node, chan: &(msgs::ChannelUpdate, msgs::ChannelUpdate, [u8; 32], Transaction), commitment_tx: Option<Transaction>, has_htlc_tx: HTLCType) -> Vec<Transaction> {
5315                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
5316                 assert!(node_txn.len() >= if commitment_tx.is_some() { 0 } else { 1 } + if has_htlc_tx == HTLCType::NONE { 0 } else { 1 });
5317
5318                 let mut res = Vec::with_capacity(2);
5319                 node_txn.retain(|tx| {
5320                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == chan.3.txid() {
5321                                 check_spends!(tx, chan.3.clone());
5322                                 if commitment_tx.is_none() {
5323                                         res.push(tx.clone());
5324                                 }
5325                                 false
5326                         } else { true }
5327                 });
5328                 if let Some(explicit_tx) = commitment_tx {
5329                         res.push(explicit_tx.clone());
5330                 }
5331
5332                 assert_eq!(res.len(), 1);
5333
5334                 if has_htlc_tx != HTLCType::NONE {
5335                         node_txn.retain(|tx| {
5336                                 if tx.input.len() == 1 && tx.input[0].previous_output.txid == res[0].txid() {
5337                                         check_spends!(tx, res[0].clone());
5338                                         if has_htlc_tx == HTLCType::TIMEOUT {
5339                                                 assert!(tx.lock_time != 0);
5340                                         } else {
5341                                                 assert!(tx.lock_time == 0);
5342                                         }
5343                                         res.push(tx.clone());
5344                                         false
5345                                 } else { true }
5346                         });
5347                         assert!(res.len() == 2 || res.len() == 3);
5348                         if res.len() == 3 {
5349                                 assert_eq!(res[1], res[2]);
5350                         }
5351                 }
5352
5353                 assert!(node_txn.is_empty());
5354                 res
5355         }
5356
5357         /// Tests that the given node has broadcast a claim transaction against the provided revoked
5358         /// HTLC transaction.
5359         fn test_revoked_htlc_claim_txn_broadcast(node: &Node, revoked_tx: Transaction) {
5360                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
5361                 assert_eq!(node_txn.len(), 1);
5362                 node_txn.retain(|tx| {
5363                         if tx.input.len() == 1 && tx.input[0].previous_output.txid == revoked_tx.txid() {
5364                                 check_spends!(tx, revoked_tx.clone());
5365                                 false
5366                         } else { true }
5367                 });
5368                 assert!(node_txn.is_empty());
5369         }
5370
5371         fn check_preimage_claim(node: &Node, prev_txn: &Vec<Transaction>) -> Vec<Transaction> {
5372                 let mut node_txn = node.tx_broadcaster.txn_broadcasted.lock().unwrap();
5373
5374                 assert!(node_txn.len() >= 1);
5375                 assert_eq!(node_txn[0].input.len(), 1);
5376                 let mut found_prev = false;
5377
5378                 for tx in prev_txn {
5379                         if node_txn[0].input[0].previous_output.txid == tx.txid() {
5380                                 check_spends!(node_txn[0], tx.clone());
5381                                 assert!(node_txn[0].input[0].witness[2].len() > 106); // must spend an htlc output
5382                                 assert_eq!(tx.input.len(), 1); // must spend a commitment tx
5383
5384                                 found_prev = true;
5385                                 break;
5386                         }
5387                 }
5388                 assert!(found_prev);
5389
5390                 let mut res = Vec::new();
5391                 mem::swap(&mut *node_txn, &mut res);
5392                 res
5393         }
5394
5395         fn get_announce_close_broadcast_events(nodes: &Vec<Node>, a: usize, b: usize) {
5396                 let events_1 = nodes[a].node.get_and_clear_pending_msg_events();
5397                 assert_eq!(events_1.len(), 1);
5398                 let as_update = match events_1[0] {
5399                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5400                                 msg.clone()
5401                         },
5402                         _ => panic!("Unexpected event"),
5403                 };
5404
5405                 let events_2 = nodes[b].node.get_and_clear_pending_msg_events();
5406                 assert_eq!(events_2.len(), 1);
5407                 let bs_update = match events_2[0] {
5408                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5409                                 msg.clone()
5410                         },
5411                         _ => panic!("Unexpected event"),
5412                 };
5413
5414                 for node in nodes {
5415                         node.router.handle_channel_update(&as_update).unwrap();
5416                         node.router.handle_channel_update(&bs_update).unwrap();
5417                 }
5418         }
5419
5420         macro_rules! expect_pending_htlcs_forwardable {
5421                 ($node: expr) => {{
5422                         let events = $node.node.get_and_clear_pending_events();
5423                         assert_eq!(events.len(), 1);
5424                         match events[0] {
5425                                 Event::PendingHTLCsForwardable { .. } => { },
5426                                 _ => panic!("Unexpected event"),
5427                         };
5428                         $node.node.channel_state.lock().unwrap().next_forward = Instant::now();
5429                         $node.node.process_pending_htlc_forwards();
5430                 }}
5431         }
5432
5433         fn do_channel_reserve_test(test_recv: bool) {
5434                 use util::rng;
5435                 use std::sync::atomic::Ordering;
5436                 use ln::msgs::HandleError;
5437
5438                 macro_rules! get_channel_value_stat {
5439                         ($node: expr, $channel_id: expr) => {{
5440                                 let chan_lock = $node.node.channel_state.lock().unwrap();
5441                                 let chan = chan_lock.by_id.get(&$channel_id).unwrap();
5442                                 chan.get_value_stat()
5443                         }}
5444                 }
5445
5446                 let mut nodes = create_network(3);
5447                 let chan_1 = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 1900, 1001);
5448                 let chan_2 = create_announced_chan_between_nodes_with_value(&nodes, 1, 2, 1900, 1001);
5449
5450                 let mut stat01 = get_channel_value_stat!(nodes[0], chan_1.2);
5451                 let mut stat11 = get_channel_value_stat!(nodes[1], chan_1.2);
5452
5453                 let mut stat12 = get_channel_value_stat!(nodes[1], chan_2.2);
5454                 let mut stat22 = get_channel_value_stat!(nodes[2], chan_2.2);
5455
5456                 macro_rules! get_route_and_payment_hash {
5457                         ($recv_value: expr) => {{
5458                                 let route = nodes[0].router.get_route(&nodes.last().unwrap().node.get_our_node_id(), None, &Vec::new(), $recv_value, TEST_FINAL_CLTV).unwrap();
5459                                 let (payment_preimage, payment_hash) = get_payment_preimage_hash!(nodes[0]);
5460                                 (route, payment_hash, payment_preimage)
5461                         }}
5462                 };
5463
5464                 macro_rules! expect_forward {
5465                         ($node: expr) => {{
5466                                 let mut events = $node.node.get_and_clear_pending_msg_events();
5467                                 assert_eq!(events.len(), 1);
5468                                 check_added_monitors!($node, 1);
5469                                 let payment_event = SendEvent::from_event(events.remove(0));
5470                                 payment_event
5471                         }}
5472                 }
5473
5474                 macro_rules! expect_payment_received {
5475                         ($node: expr, $expected_payment_hash: expr, $expected_recv_value: expr) => {
5476                                 let events = $node.node.get_and_clear_pending_events();
5477                                 assert_eq!(events.len(), 1);
5478                                 match events[0] {
5479                                         Event::PaymentReceived { ref payment_hash, amt } => {
5480                                                 assert_eq!($expected_payment_hash, *payment_hash);
5481                                                 assert_eq!($expected_recv_value, amt);
5482                                         },
5483                                         _ => panic!("Unexpected event"),
5484                                 }
5485                         }
5486                 };
5487
5488                 let feemsat = 239; // somehow we know?
5489                 let total_fee_msat = (nodes.len() - 2) as u64 * 239;
5490
5491                 let recv_value_0 = stat01.their_max_htlc_value_in_flight_msat - total_fee_msat;
5492
5493                 // attempt to send amt_msat > their_max_htlc_value_in_flight_msat
5494                 {
5495                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_0 + 1);
5496                         assert!(route.hops.iter().rev().skip(1).all(|h| h.fee_msat == feemsat));
5497                         let err = nodes[0].node.send_payment(route, our_payment_hash).err().unwrap();
5498                         match err {
5499                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our max HTLC value in flight"),
5500                                 _ => panic!("Unknown error variants"),
5501                         }
5502                 }
5503
5504                 let mut htlc_id = 0;
5505                 // channel reserve is bigger than their_max_htlc_value_in_flight_msat so loop to deplete
5506                 // nodes[0]'s wealth
5507                 loop {
5508                         let amt_msat = recv_value_0 + total_fee_msat;
5509                         if stat01.value_to_self_msat - amt_msat < stat01.channel_reserve_msat {
5510                                 break;
5511                         }
5512                         send_payment(&nodes[0], &vec![&nodes[1], &nodes[2]][..], recv_value_0);
5513                         htlc_id += 1;
5514
5515                         let (stat01_, stat11_, stat12_, stat22_) = (
5516                                 get_channel_value_stat!(nodes[0], chan_1.2),
5517                                 get_channel_value_stat!(nodes[1], chan_1.2),
5518                                 get_channel_value_stat!(nodes[1], chan_2.2),
5519                                 get_channel_value_stat!(nodes[2], chan_2.2),
5520                         );
5521
5522                         assert_eq!(stat01_.value_to_self_msat, stat01.value_to_self_msat - amt_msat);
5523                         assert_eq!(stat11_.value_to_self_msat, stat11.value_to_self_msat + amt_msat);
5524                         assert_eq!(stat12_.value_to_self_msat, stat12.value_to_self_msat - (amt_msat - feemsat));
5525                         assert_eq!(stat22_.value_to_self_msat, stat22.value_to_self_msat + (amt_msat - feemsat));
5526                         stat01 = stat01_; stat11 = stat11_; stat12 = stat12_; stat22 = stat22_;
5527                 }
5528
5529                 {
5530                         let recv_value = stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat;
5531                         // attempt to get channel_reserve violation
5532                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value + 1);
5533                         let err = nodes[0].node.send_payment(route.clone(), our_payment_hash).err().unwrap();
5534                         match err {
5535                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5536                                 _ => panic!("Unknown error variants"),
5537                         }
5538                 }
5539
5540                 // adding pending output
5541                 let recv_value_1 = (stat01.value_to_self_msat - stat01.channel_reserve_msat - total_fee_msat)/2;
5542                 let amt_msat_1 = recv_value_1 + total_fee_msat;
5543
5544                 let (route_1, our_payment_hash_1, our_payment_preimage_1) = get_route_and_payment_hash!(recv_value_1);
5545                 let payment_event_1 = {
5546                         nodes[0].node.send_payment(route_1, our_payment_hash_1).unwrap();
5547                         check_added_monitors!(nodes[0], 1);
5548
5549                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
5550                         assert_eq!(events.len(), 1);
5551                         SendEvent::from_event(events.remove(0))
5552                 };
5553                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event_1.msgs[0]).unwrap();
5554
5555                 // channel reserve test with htlc pending output > 0
5556                 let recv_value_2 = stat01.value_to_self_msat - amt_msat_1 - stat01.channel_reserve_msat - total_fee_msat;
5557                 {
5558                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
5559                         match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
5560                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5561                                 _ => panic!("Unknown error variants"),
5562                         }
5563                 }
5564
5565                 {
5566                         // test channel_reserve test on nodes[1] side
5567                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_2 + 1);
5568
5569                         // Need to manually create update_add_htlc message to go around the channel reserve check in send_htlc()
5570                         let secp_ctx = Secp256k1::new();
5571                         let session_priv = SecretKey::from_slice(&secp_ctx, &{
5572                                 let mut session_key = [0; 32];
5573                                 rng::fill_bytes(&mut session_key);
5574                                 session_key
5575                         }).expect("RNG is bad!");
5576
5577                         let cur_height = nodes[0].node.latest_block_height.load(Ordering::Acquire) as u32 + 1;
5578                         let onion_keys = ChannelManager::construct_onion_keys(&secp_ctx, &route, &session_priv).unwrap();
5579                         let (onion_payloads, htlc_msat, htlc_cltv) = ChannelManager::build_onion_payloads(&route, cur_height).unwrap();
5580                         let onion_packet = ChannelManager::construct_onion_packet(onion_payloads, onion_keys, &our_payment_hash);
5581                         let msg = msgs::UpdateAddHTLC {
5582                                 channel_id: chan_1.2,
5583                                 htlc_id,
5584                                 amount_msat: htlc_msat,
5585                                 payment_hash: our_payment_hash,
5586                                 cltv_expiry: htlc_cltv,
5587                                 onion_routing_packet: onion_packet,
5588                         };
5589
5590                         if test_recv {
5591                                 let err = nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &msg).err().unwrap();
5592                                 match err {
5593                                         HandleError{err, .. } => assert_eq!(err, "Remote HTLC add would put them over their reserve value"),
5594                                 }
5595                                 // If we send a garbage message, the channel should get closed, making the rest of this test case fail.
5596                                 assert_eq!(nodes[1].node.list_channels().len(), 1);
5597                                 assert_eq!(nodes[1].node.list_channels().len(), 1);
5598                                 let channel_close_broadcast = nodes[1].node.get_and_clear_pending_msg_events();
5599                                 assert_eq!(channel_close_broadcast.len(), 1);
5600                                 match channel_close_broadcast[0] {
5601                                         MessageSendEvent::BroadcastChannelUpdate { ref msg } => {
5602                                                 assert_eq!(msg.contents.flags & 2, 2);
5603                                         },
5604                                         _ => panic!("Unexpected event"),
5605                                 }
5606                                 return;
5607                         }
5608                 }
5609
5610                 // split the rest to test holding cell
5611                 let recv_value_21 = recv_value_2/2;
5612                 let recv_value_22 = recv_value_2 - recv_value_21 - total_fee_msat;
5613                 {
5614                         let stat = get_channel_value_stat!(nodes[0], chan_1.2);
5615                         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);
5616                 }
5617
5618                 // now see if they go through on both sides
5619                 let (route_21, our_payment_hash_21, our_payment_preimage_21) = get_route_and_payment_hash!(recv_value_21);
5620                 // but this will stuck in the holding cell
5621                 nodes[0].node.send_payment(route_21, our_payment_hash_21).unwrap();
5622                 check_added_monitors!(nodes[0], 0);
5623                 let events = nodes[0].node.get_and_clear_pending_events();
5624                 assert_eq!(events.len(), 0);
5625
5626                 // test with outbound holding cell amount > 0
5627                 {
5628                         let (route, our_payment_hash, _) = get_route_and_payment_hash!(recv_value_22+1);
5629                         match nodes[0].node.send_payment(route, our_payment_hash).err().unwrap() {
5630                                 APIError::ChannelUnavailable{err} => assert_eq!(err, "Cannot send value that would put us over our reserve value"),
5631                                 _ => panic!("Unknown error variants"),
5632                         }
5633                 }
5634
5635                 let (route_22, our_payment_hash_22, our_payment_preimage_22) = get_route_and_payment_hash!(recv_value_22);
5636                 // this will also stuck in the holding cell
5637                 nodes[0].node.send_payment(route_22, our_payment_hash_22).unwrap();
5638                 check_added_monitors!(nodes[0], 0);
5639                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
5640                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
5641
5642                 // flush the pending htlc
5643                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event_1.commitment_msg).unwrap();
5644                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
5645                 check_added_monitors!(nodes[1], 1);
5646
5647                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
5648                 check_added_monitors!(nodes[0], 1);
5649                 let commitment_update_2 = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
5650
5651                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_commitment_signed).unwrap();
5652                 let bs_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
5653                 // No commitment_signed so get_event_msg's assert(len == 1) passes
5654                 check_added_monitors!(nodes[0], 1);
5655
5656                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
5657                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
5658                 check_added_monitors!(nodes[1], 1);
5659
5660                 expect_pending_htlcs_forwardable!(nodes[1]);
5661
5662                 let ref payment_event_11 = expect_forward!(nodes[1]);
5663                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_11.msgs[0]).unwrap();
5664                 commitment_signed_dance!(nodes[2], nodes[1], payment_event_11.commitment_msg, false);
5665
5666                 expect_pending_htlcs_forwardable!(nodes[2]);
5667                 expect_payment_received!(nodes[2], our_payment_hash_1, recv_value_1);
5668
5669                 // flush the htlcs in the holding cell
5670                 assert_eq!(commitment_update_2.update_add_htlcs.len(), 2);
5671                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[0]).unwrap();
5672                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &commitment_update_2.update_add_htlcs[1]).unwrap();
5673                 commitment_signed_dance!(nodes[1], nodes[0], &commitment_update_2.commitment_signed, false);
5674                 expect_pending_htlcs_forwardable!(nodes[1]);
5675
5676                 let ref payment_event_3 = expect_forward!(nodes[1]);
5677                 assert_eq!(payment_event_3.msgs.len(), 2);
5678                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[0]).unwrap();
5679                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event_3.msgs[1]).unwrap();
5680
5681                 commitment_signed_dance!(nodes[2], nodes[1], &payment_event_3.commitment_msg, false);
5682                 expect_pending_htlcs_forwardable!(nodes[2]);
5683
5684                 let events = nodes[2].node.get_and_clear_pending_events();
5685                 assert_eq!(events.len(), 2);
5686                 match events[0] {
5687                         Event::PaymentReceived { ref payment_hash, amt } => {
5688                                 assert_eq!(our_payment_hash_21, *payment_hash);
5689                                 assert_eq!(recv_value_21, amt);
5690                         },
5691                         _ => panic!("Unexpected event"),
5692                 }
5693                 match events[1] {
5694                         Event::PaymentReceived { ref payment_hash, amt } => {
5695                                 assert_eq!(our_payment_hash_22, *payment_hash);
5696                                 assert_eq!(recv_value_22, amt);
5697                         },
5698                         _ => panic!("Unexpected event"),
5699                 }
5700
5701                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_1);
5702                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_21);
5703                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), our_payment_preimage_22);
5704
5705                 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);
5706                 let stat0 = get_channel_value_stat!(nodes[0], chan_1.2);
5707                 assert_eq!(stat0.value_to_self_msat, expected_value_to_self);
5708                 assert_eq!(stat0.value_to_self_msat, stat0.channel_reserve_msat);
5709
5710                 let stat2 = get_channel_value_stat!(nodes[2], chan_2.2);
5711                 assert_eq!(stat2.value_to_self_msat, stat22.value_to_self_msat + recv_value_1 + recv_value_21 + recv_value_22);
5712         }
5713
5714         #[test]
5715         fn channel_reserve_test() {
5716                 do_channel_reserve_test(false);
5717                 do_channel_reserve_test(true);
5718         }
5719
5720         #[test]
5721         fn channel_monitor_network_test() {
5722                 // Simple test which builds a network of ChannelManagers, connects them to each other, and
5723                 // tests that ChannelMonitor is able to recover from various states.
5724                 let nodes = create_network(5);
5725
5726                 // Create some initial channels
5727                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5728                 let chan_2 = create_announced_chan_between_nodes(&nodes, 1, 2);
5729                 let chan_3 = create_announced_chan_between_nodes(&nodes, 2, 3);
5730                 let chan_4 = create_announced_chan_between_nodes(&nodes, 3, 4);
5731
5732                 // Rebalance the network a bit by relaying one payment through all the channels...
5733                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5734                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5735                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5736                 send_payment(&nodes[0], &vec!(&nodes[1], &nodes[2], &nodes[3], &nodes[4])[..], 8000000);
5737
5738                 // Simple case with no pending HTLCs:
5739                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), true);
5740                 {
5741                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_1, None, HTLCType::NONE);
5742                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5743                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
5744                         test_txn_broadcast(&nodes[0], &chan_1, None, HTLCType::NONE);
5745                 }
5746                 get_announce_close_broadcast_events(&nodes, 0, 1);
5747                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5748                 assert_eq!(nodes[1].node.list_channels().len(), 1);
5749
5750                 // One pending HTLC is discarded by the force-close:
5751                 let payment_preimage_1 = route_payment(&nodes[1], &vec!(&nodes[2], &nodes[3])[..], 3000000).0;
5752
5753                 // Simple case of one pending HTLC to HTLC-Timeout
5754                 nodes[1].node.peer_disconnected(&nodes[2].node.get_our_node_id(), true);
5755                 {
5756                         let mut node_txn = test_txn_broadcast(&nodes[1], &chan_2, None, HTLCType::TIMEOUT);
5757                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5758                         nodes[2].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn.drain(..).next().unwrap()] }, 1);
5759                         test_txn_broadcast(&nodes[2], &chan_2, None, HTLCType::NONE);
5760                 }
5761                 get_announce_close_broadcast_events(&nodes, 1, 2);
5762                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5763                 assert_eq!(nodes[2].node.list_channels().len(), 1);
5764
5765                 macro_rules! claim_funds {
5766                         ($node: expr, $prev_node: expr, $preimage: expr) => {
5767                                 {
5768                                         assert!($node.node.claim_funds($preimage));
5769                                         check_added_monitors!($node, 1);
5770
5771                                         let events = $node.node.get_and_clear_pending_msg_events();
5772                                         assert_eq!(events.len(), 1);
5773                                         match events[0] {
5774                                                 MessageSendEvent::UpdateHTLCs { ref node_id, updates: msgs::CommitmentUpdate { ref update_add_htlcs, ref update_fail_htlcs, .. } } => {
5775                                                         assert!(update_add_htlcs.is_empty());
5776                                                         assert!(update_fail_htlcs.is_empty());
5777                                                         assert_eq!(*node_id, $prev_node.node.get_our_node_id());
5778                                                 },
5779                                                 _ => panic!("Unexpected event"),
5780                                         };
5781                                 }
5782                         }
5783                 }
5784
5785                 // nodes[3] gets the preimage, but nodes[2] already disconnected, resulting in a nodes[2]
5786                 // HTLC-Timeout and a nodes[3] claim against it (+ its own announces)
5787                 nodes[2].node.peer_disconnected(&nodes[3].node.get_our_node_id(), true);
5788                 {
5789                         let node_txn = test_txn_broadcast(&nodes[2], &chan_3, None, HTLCType::TIMEOUT);
5790
5791                         // Claim the payment on nodes[3], giving it knowledge of the preimage
5792                         claim_funds!(nodes[3], nodes[2], payment_preimage_1);
5793
5794                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5795                         nodes[3].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 1);
5796
5797                         check_preimage_claim(&nodes[3], &node_txn);
5798                 }
5799                 get_announce_close_broadcast_events(&nodes, 2, 3);
5800                 assert_eq!(nodes[2].node.list_channels().len(), 0);
5801                 assert_eq!(nodes[3].node.list_channels().len(), 1);
5802
5803                 { // Cheat and reset nodes[4]'s height to 1
5804                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5805                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![] }, 1);
5806                 }
5807
5808                 assert_eq!(nodes[3].node.latest_block_height.load(Ordering::Acquire), 1);
5809                 assert_eq!(nodes[4].node.latest_block_height.load(Ordering::Acquire), 1);
5810                 // One pending HTLC to time out:
5811                 let payment_preimage_2 = route_payment(&nodes[3], &vec!(&nodes[4])[..], 3000000).0;
5812                 // CLTV expires at TEST_FINAL_CLTV + 1 (current height) + 1 (added in send_payment for
5813                 // buffer space).
5814
5815                 {
5816                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5817                         nodes[3].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
5818                         for i in 3..TEST_FINAL_CLTV + 2 + HTLC_FAIL_TIMEOUT_BLOCKS + 1 {
5819                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5820                                 nodes[3].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
5821                         }
5822
5823                         let node_txn = test_txn_broadcast(&nodes[3], &chan_4, None, HTLCType::TIMEOUT);
5824
5825                         // Claim the payment on nodes[4], giving it knowledge of the preimage
5826                         claim_funds!(nodes[4], nodes[3], payment_preimage_2);
5827
5828                         header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5829                         nodes[4].chain_monitor.block_connected_checked(&header, 2, &Vec::new()[..], &[0; 0]);
5830                         for i in 3..TEST_FINAL_CLTV + 2 - CLTV_CLAIM_BUFFER + 1 {
5831                                 header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5832                                 nodes[4].chain_monitor.block_connected_checked(&header, i, &Vec::new()[..], &[0; 0]);
5833                         }
5834
5835                         test_txn_broadcast(&nodes[4], &chan_4, None, HTLCType::SUCCESS);
5836
5837                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5838                         nodes[4].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, TEST_FINAL_CLTV - 5);
5839
5840                         check_preimage_claim(&nodes[4], &node_txn);
5841                 }
5842                 get_announce_close_broadcast_events(&nodes, 3, 4);
5843                 assert_eq!(nodes[3].node.list_channels().len(), 0);
5844                 assert_eq!(nodes[4].node.list_channels().len(), 0);
5845         }
5846
5847         #[test]
5848         fn test_justice_tx() {
5849                 // Test justice txn built on revoked HTLC-Success tx, against both sides
5850
5851                 let nodes = create_network(2);
5852                 // Create some new channels:
5853                 let chan_5 = create_announced_chan_between_nodes(&nodes, 0, 1);
5854
5855                 // A pending HTLC which will be revoked:
5856                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5857                 // Get the will-be-revoked local txn from nodes[0]
5858                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
5859                 assert_eq!(revoked_local_txn.len(), 2); // First commitment tx, then HTLC tx
5860                 assert_eq!(revoked_local_txn[0].input.len(), 1);
5861                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_5.3.txid());
5862                 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to 0 are present
5863                 assert_eq!(revoked_local_txn[1].input.len(), 1);
5864                 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
5865                 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
5866                 // Revoke the old state
5867                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_3);
5868
5869                 {
5870                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5871                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5872                         {
5873                                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5874                                 assert_eq!(node_txn.len(), 3);
5875                                 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
5876                                 assert_eq!(node_txn[0].input.len(), 2); // We should claim the revoked output and the HTLC output
5877
5878                                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5879                                 node_txn.swap_remove(0);
5880                         }
5881                         test_txn_broadcast(&nodes[1], &chan_5, None, HTLCType::NONE);
5882
5883                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5884                         let node_txn = test_txn_broadcast(&nodes[0], &chan_5, Some(revoked_local_txn[0].clone()), HTLCType::TIMEOUT);
5885                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5886                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
5887                         test_revoked_htlc_claim_txn_broadcast(&nodes[1], node_txn[1].clone());
5888                 }
5889                 get_announce_close_broadcast_events(&nodes, 0, 1);
5890
5891                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5892                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5893
5894                 // We test justice_tx build by A on B's revoked HTLC-Success tx
5895                 // Create some new channels:
5896                 let chan_6 = create_announced_chan_between_nodes(&nodes, 0, 1);
5897
5898                 // A pending HTLC which will be revoked:
5899                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5900                 // Get the will-be-revoked local txn from B
5901                 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
5902                 assert_eq!(revoked_local_txn.len(), 1); // Only commitment tx
5903                 assert_eq!(revoked_local_txn[0].input.len(), 1);
5904                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_6.3.txid());
5905                 assert_eq!(revoked_local_txn[0].output.len(), 2); // Only HTLC and output back to A are present
5906                 // Revoke the old state
5907                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_4);
5908                 {
5909                         let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5910                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5911                         {
5912                                 let mut node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
5913                                 assert_eq!(node_txn.len(), 3);
5914                                 assert_eq!(node_txn.pop().unwrap(), node_txn[0]); // An outpoint registration will result in a 2nd block_connected
5915                                 assert_eq!(node_txn[0].input.len(), 1); // We claim the received HTLC output
5916
5917                                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5918                                 node_txn.swap_remove(0);
5919                         }
5920                         test_txn_broadcast(&nodes[0], &chan_6, None, HTLCType::NONE);
5921
5922                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5923                         let node_txn = test_txn_broadcast(&nodes[1], &chan_6, Some(revoked_local_txn[0].clone()), HTLCType::SUCCESS);
5924                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5925                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[1].clone()] }, 1);
5926                         test_revoked_htlc_claim_txn_broadcast(&nodes[0], node_txn[1].clone());
5927                 }
5928                 get_announce_close_broadcast_events(&nodes, 0, 1);
5929                 assert_eq!(nodes[0].node.list_channels().len(), 0);
5930                 assert_eq!(nodes[1].node.list_channels().len(), 0);
5931         }
5932
5933         #[test]
5934         fn revoked_output_claim() {
5935                 // Simple test to ensure a node will claim a revoked output when a stale remote commitment
5936                 // transaction is broadcast by its counterparty
5937                 let nodes = create_network(2);
5938                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5939                 // node[0] is gonna to revoke an old state thus node[1] should be able to claim the revoked output
5940                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5941                 assert_eq!(revoked_local_txn.len(), 1);
5942                 // Only output is the full channel value back to nodes[0]:
5943                 assert_eq!(revoked_local_txn[0].output.len(), 1);
5944                 // Send a payment through, updating everyone's latest commitment txn
5945                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 5000000);
5946
5947                 // Inform nodes[1] that nodes[0] broadcast a stale tx
5948                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5949                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5950                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5951                 assert_eq!(node_txn.len(), 3); // nodes[1] will broadcast justice tx twice, and its own local state once
5952
5953                 assert_eq!(node_txn[0], node_txn[2]);
5954
5955                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
5956                 check_spends!(node_txn[1], chan_1.3.clone());
5957
5958                 // Inform nodes[0] that a watchtower cheated on its behalf, so it will force-close the chan
5959                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5960                 get_announce_close_broadcast_events(&nodes, 0, 1);
5961         }
5962
5963         #[test]
5964         fn claim_htlc_outputs_shared_tx() {
5965                 // Node revoked old state, htlcs haven't time out yet, claim them in shared justice tx
5966                 let nodes = create_network(2);
5967
5968                 // Create some new channel:
5969                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
5970
5971                 // Rebalance the network to generate htlc in the two directions
5972                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
5973                 // 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
5974                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
5975                 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
5976
5977                 // Get the will-be-revoked local txn from node[0]
5978                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
5979                 assert_eq!(revoked_local_txn.len(), 2); // commitment tx + 1 HTLC-Timeout tx
5980                 assert_eq!(revoked_local_txn[0].input.len(), 1);
5981                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
5982                 assert_eq!(revoked_local_txn[1].input.len(), 1);
5983                 assert_eq!(revoked_local_txn[1].input[0].previous_output.txid, revoked_local_txn[0].txid());
5984                 assert_eq!(revoked_local_txn[1].input[0].witness.last().unwrap().len(), 133); // HTLC-Timeout
5985                 check_spends!(revoked_local_txn[1], revoked_local_txn[0].clone());
5986
5987                 //Revoke the old state
5988                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
5989
5990                 {
5991                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
5992
5993                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5994
5995                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
5996                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
5997                         assert_eq!(node_txn.len(), 4);
5998
5999                         assert_eq!(node_txn[0].input.len(), 3); // Claim the revoked output + both revoked HTLC outputs
6000                         check_spends!(node_txn[0], revoked_local_txn[0].clone());
6001
6002                         assert_eq!(node_txn[0], node_txn[3]); // justice tx is duplicated due to block re-scanning
6003
6004                         let mut witness_lens = BTreeSet::new();
6005                         witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
6006                         witness_lens.insert(node_txn[0].input[1].witness.last().unwrap().len());
6007                         witness_lens.insert(node_txn[0].input[2].witness.last().unwrap().len());
6008                         assert_eq!(witness_lens.len(), 3);
6009                         assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
6010                         assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
6011                         assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
6012
6013                         // Next nodes[1] broadcasts its current local tx state:
6014                         assert_eq!(node_txn[1].input.len(), 1);
6015                         assert_eq!(node_txn[1].input[0].previous_output.txid, chan_1.3.txid()); //Spending funding tx unique txouput, tx broadcasted by ChannelManager
6016
6017                         assert_eq!(node_txn[2].input.len(), 1);
6018                         let witness_script = node_txn[2].clone().input[0].witness.pop().unwrap();
6019                         assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
6020                         assert_eq!(node_txn[2].input[0].previous_output.txid, node_txn[1].txid());
6021                         assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
6022                         assert_ne!(node_txn[2].input[0].previous_output.txid, node_txn[0].input[1].previous_output.txid);
6023                 }
6024                 get_announce_close_broadcast_events(&nodes, 0, 1);
6025                 assert_eq!(nodes[0].node.list_channels().len(), 0);
6026                 assert_eq!(nodes[1].node.list_channels().len(), 0);
6027         }
6028
6029         #[test]
6030         fn claim_htlc_outputs_single_tx() {
6031                 // Node revoked old state, htlcs have timed out, claim each of them in separated justice tx
6032                 let nodes = create_network(2);
6033
6034                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
6035
6036                 // Rebalance the network to generate htlc in the two directions
6037                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
6038                 // 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
6039                 // time as two different claim transactions as we're gonna to timeout htlc with given a high current height
6040                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
6041                 let _payment_preimage_2 = route_payment(&nodes[1], &vec!(&nodes[0])[..], 3000000).0;
6042
6043                 // Get the will-be-revoked local txn from node[0]
6044                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
6045
6046                 //Revoke the old state
6047                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage_1);
6048
6049                 {
6050                         let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6051
6052                         nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
6053
6054                         nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 200);
6055                         let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
6056                         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)
6057
6058                         assert_eq!(node_txn[0], node_txn[7]);
6059                         assert_eq!(node_txn[1], node_txn[8]);
6060                         assert_eq!(node_txn[2], node_txn[9]);
6061                         assert_eq!(node_txn[3], node_txn[10]);
6062                         assert_eq!(node_txn[4], node_txn[11]);
6063                         assert_eq!(node_txn[3], node_txn[5]); //local commitment tx + htlc timeout tx broadcated by ChannelManger
6064                         assert_eq!(node_txn[4], node_txn[6]);
6065
6066                         assert_eq!(node_txn[0].input.len(), 1);
6067                         assert_eq!(node_txn[1].input.len(), 1);
6068                         assert_eq!(node_txn[2].input.len(), 1);
6069
6070                         let mut revoked_tx_map = HashMap::new();
6071                         revoked_tx_map.insert(revoked_local_txn[0].txid(), revoked_local_txn[0].clone());
6072                         node_txn[0].verify(&revoked_tx_map).unwrap();
6073                         node_txn[1].verify(&revoked_tx_map).unwrap();
6074                         node_txn[2].verify(&revoked_tx_map).unwrap();
6075
6076                         let mut witness_lens = BTreeSet::new();
6077                         witness_lens.insert(node_txn[0].input[0].witness.last().unwrap().len());
6078                         witness_lens.insert(node_txn[1].input[0].witness.last().unwrap().len());
6079                         witness_lens.insert(node_txn[2].input[0].witness.last().unwrap().len());
6080                         assert_eq!(witness_lens.len(), 3);
6081                         assert_eq!(*witness_lens.iter().skip(0).next().unwrap(), 77); // revoked to_local
6082                         assert_eq!(*witness_lens.iter().skip(1).next().unwrap(), 133); // revoked offered HTLC
6083                         assert_eq!(*witness_lens.iter().skip(2).next().unwrap(), 138); // revoked received HTLC
6084
6085                         assert_eq!(node_txn[3].input.len(), 1);
6086                         check_spends!(node_txn[3], chan_1.3.clone());
6087
6088                         assert_eq!(node_txn[4].input.len(), 1);
6089                         let witness_script = node_txn[4].input[0].witness.last().unwrap();
6090                         assert_eq!(witness_script.len(), 133); //Spending an offered htlc output
6091                         assert_eq!(node_txn[4].input[0].previous_output.txid, node_txn[3].txid());
6092                         assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[0].input[0].previous_output.txid);
6093                         assert_ne!(node_txn[4].input[0].previous_output.txid, node_txn[1].input[0].previous_output.txid);
6094                 }
6095                 get_announce_close_broadcast_events(&nodes, 0, 1);
6096                 assert_eq!(nodes[0].node.list_channels().len(), 0);
6097                 assert_eq!(nodes[1].node.list_channels().len(), 0);
6098         }
6099
6100         #[test]
6101         fn test_htlc_ignore_latest_remote_commitment() {
6102                 // Test that HTLC transactions spending the latest remote commitment transaction are simply
6103                 // ignored if we cannot claim them. This originally tickled an invalid unwrap().
6104                 let nodes = create_network(2);
6105                 create_announced_chan_between_nodes(&nodes, 0, 1);
6106
6107                 route_payment(&nodes[0], &[&nodes[1]], 10000000);
6108                 nodes[0].node.force_close_channel(&nodes[0].node.list_channels()[0].channel_id);
6109                 {
6110                         let events = nodes[0].node.get_and_clear_pending_msg_events();
6111                         assert_eq!(events.len(), 1);
6112                         match events[0] {
6113                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6114                                         assert_eq!(flags & 0b10, 0b10);
6115                                 },
6116                                 _ => panic!("Unexpected event"),
6117                         }
6118                 }
6119
6120                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
6121                 assert_eq!(node_txn.len(), 2);
6122
6123                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6124                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
6125
6126                 {
6127                         let events = nodes[1].node.get_and_clear_pending_msg_events();
6128                         assert_eq!(events.len(), 1);
6129                         match events[0] {
6130                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6131                                         assert_eq!(flags & 0b10, 0b10);
6132                                 },
6133                                 _ => panic!("Unexpected event"),
6134                         }
6135                 }
6136
6137                 // Duplicate the block_connected call since this may happen due to other listeners
6138                 // registering new transactions
6139                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&node_txn[0], &node_txn[1]], &[1; 2]);
6140         }
6141
6142         #[test]
6143         fn test_force_close_fail_back() {
6144                 // Check which HTLCs are failed-backwards on channel force-closure
6145                 let mut nodes = create_network(3);
6146                 create_announced_chan_between_nodes(&nodes, 0, 1);
6147                 create_announced_chan_between_nodes(&nodes, 1, 2);
6148
6149                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, 42).unwrap();
6150
6151                 let (our_payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
6152
6153                 let mut payment_event = {
6154                         nodes[0].node.send_payment(route, our_payment_hash).unwrap();
6155                         check_added_monitors!(nodes[0], 1);
6156
6157                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6158                         assert_eq!(events.len(), 1);
6159                         SendEvent::from_event(events.remove(0))
6160                 };
6161
6162                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6163                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
6164
6165                 let events_1 = nodes[1].node.get_and_clear_pending_events();
6166                 assert_eq!(events_1.len(), 1);
6167                 match events_1[0] {
6168                         Event::PendingHTLCsForwardable { .. } => { },
6169                         _ => panic!("Unexpected event"),
6170                 };
6171
6172                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
6173                 nodes[1].node.process_pending_htlc_forwards();
6174
6175                 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6176                 assert_eq!(events_2.len(), 1);
6177                 payment_event = SendEvent::from_event(events_2.remove(0));
6178                 assert_eq!(payment_event.msgs.len(), 1);
6179
6180                 check_added_monitors!(nodes[1], 1);
6181                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6182                 nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
6183                 check_added_monitors!(nodes[2], 1);
6184                 let (_, _) = get_revoke_commit_msgs!(nodes[2], nodes[1].node.get_our_node_id());
6185
6186                 // nodes[2] now has the latest commitment transaction, but hasn't revoked its previous
6187                 // state or updated nodes[1]' state. Now force-close and broadcast that commitment/HTLC
6188                 // transaction and ensure nodes[1] doesn't fail-backwards (this was originally a bug!).
6189
6190                 nodes[2].node.force_close_channel(&payment_event.commitment_msg.channel_id);
6191                 let events_3 = nodes[2].node.get_and_clear_pending_msg_events();
6192                 assert_eq!(events_3.len(), 1);
6193                 match events_3[0] {
6194                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6195                                 assert_eq!(flags & 0b10, 0b10);
6196                         },
6197                         _ => panic!("Unexpected event"),
6198                 }
6199
6200                 let tx = {
6201                         let mut node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
6202                         // Note that we don't bother broadcasting the HTLC-Success transaction here as we don't
6203                         // have a use for it unless nodes[2] learns the preimage somehow, the funds will go
6204                         // back to nodes[1] upon timeout otherwise.
6205                         assert_eq!(node_txn.len(), 1);
6206                         node_txn.remove(0)
6207                 };
6208
6209                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6210                 nodes[1].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
6211
6212                 let events_4 = nodes[1].node.get_and_clear_pending_msg_events();
6213                 // Note no UpdateHTLCs event here from nodes[1] to nodes[0]!
6214                 assert_eq!(events_4.len(), 1);
6215                 match events_4[0] {
6216                         MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6217                                 assert_eq!(flags & 0b10, 0b10);
6218                         },
6219                         _ => panic!("Unexpected event"),
6220                 }
6221
6222                 // Now check that if we add the preimage to ChannelMonitor it broadcasts our HTLC-Success..
6223                 {
6224                         let mut monitors = nodes[2].chan_monitor.simple_monitor.monitors.lock().unwrap();
6225                         monitors.get_mut(&OutPoint::new(Sha256dHash::from(&payment_event.commitment_msg.channel_id[..]), 0)).unwrap()
6226                                 .provide_payment_preimage(&our_payment_hash, &our_payment_preimage);
6227                 }
6228                 nodes[2].chain_monitor.block_connected_checked(&header, 1, &[&tx], &[1]);
6229                 let node_txn = nodes[2].tx_broadcaster.txn_broadcasted.lock().unwrap();
6230                 assert_eq!(node_txn.len(), 1);
6231                 assert_eq!(node_txn[0].input.len(), 1);
6232                 assert_eq!(node_txn[0].input[0].previous_output.txid, tx.txid());
6233                 assert_eq!(node_txn[0].lock_time, 0); // Must be an HTLC-Success
6234                 assert_eq!(node_txn[0].input[0].witness.len(), 5); // Must be an HTLC-Success
6235
6236                 check_spends!(node_txn[0], tx);
6237         }
6238
6239         #[test]
6240         fn test_unconf_chan() {
6241                 // After creating a chan between nodes, we disconnect all blocks previously seen to force a channel close on nodes[0] side
6242                 let nodes = create_network(2);
6243                 create_announced_chan_between_nodes(&nodes, 0, 1);
6244
6245                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
6246                 assert_eq!(channel_state.by_id.len(), 1);
6247                 assert_eq!(channel_state.short_to_id.len(), 1);
6248                 mem::drop(channel_state);
6249
6250                 let mut headers = Vec::new();
6251                 let mut header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6252                 headers.push(header.clone());
6253                 for _i in 2..100 {
6254                         header = BlockHeader { version: 0x20000000, prev_blockhash: header.bitcoin_hash(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
6255                         headers.push(header.clone());
6256                 }
6257                 while !headers.is_empty() {
6258                         nodes[0].node.block_disconnected(&headers.pop().unwrap());
6259                 }
6260                 {
6261                         let events = nodes[0].node.get_and_clear_pending_msg_events();
6262                         assert_eq!(events.len(), 1);
6263                         match events[0] {
6264                                 MessageSendEvent::BroadcastChannelUpdate { msg: msgs::ChannelUpdate { contents: msgs::UnsignedChannelUpdate { flags, .. }, .. } } => {
6265                                         assert_eq!(flags & 0b10, 0b10);
6266                                 },
6267                                 _ => panic!("Unexpected event"),
6268                         }
6269                 }
6270                 let channel_state = nodes[0].node.channel_state.lock().unwrap();
6271                 assert_eq!(channel_state.by_id.len(), 0);
6272                 assert_eq!(channel_state.short_to_id.len(), 0);
6273         }
6274
6275         macro_rules! get_chan_reestablish_msgs {
6276                 ($src_node: expr, $dst_node: expr) => {
6277                         {
6278                                 let mut res = Vec::with_capacity(1);
6279                                 for msg in $src_node.node.get_and_clear_pending_msg_events() {
6280                                         if let MessageSendEvent::SendChannelReestablish { ref node_id, ref msg } = msg {
6281                                                 assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6282                                                 res.push(msg.clone());
6283                                         } else {
6284                                                 panic!("Unexpected event")
6285                                         }
6286                                 }
6287                                 res
6288                         }
6289                 }
6290         }
6291
6292         macro_rules! handle_chan_reestablish_msgs {
6293                 ($src_node: expr, $dst_node: expr) => {
6294                         {
6295                                 let msg_events = $src_node.node.get_and_clear_pending_msg_events();
6296                                 let mut idx = 0;
6297                                 let funding_locked = if let Some(&MessageSendEvent::SendFundingLocked { ref node_id, ref msg }) = msg_events.get(0) {
6298                                         idx += 1;
6299                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6300                                         Some(msg.clone())
6301                                 } else {
6302                                         None
6303                                 };
6304
6305                                 let mut revoke_and_ack = None;
6306                                 let mut commitment_update = None;
6307                                 let order = if let Some(ev) = msg_events.get(idx) {
6308                                         idx += 1;
6309                                         match ev {
6310                                                 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
6311                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6312                                                         revoke_and_ack = Some(msg.clone());
6313                                                         RAACommitmentOrder::RevokeAndACKFirst
6314                                                 },
6315                                                 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
6316                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6317                                                         commitment_update = Some(updates.clone());
6318                                                         RAACommitmentOrder::CommitmentFirst
6319                                                 },
6320                                                 _ => panic!("Unexpected event"),
6321                                         }
6322                                 } else {
6323                                         RAACommitmentOrder::CommitmentFirst
6324                                 };
6325
6326                                 if let Some(ev) = msg_events.get(idx) {
6327                                         match ev {
6328                                                 &MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
6329                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6330                                                         assert!(revoke_and_ack.is_none());
6331                                                         revoke_and_ack = Some(msg.clone());
6332                                                 },
6333                                                 &MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
6334                                                         assert_eq!(*node_id, $dst_node.node.get_our_node_id());
6335                                                         assert!(commitment_update.is_none());
6336                                                         commitment_update = Some(updates.clone());
6337                                                 },
6338                                                 _ => panic!("Unexpected event"),
6339                                         }
6340                                 }
6341
6342                                 (funding_locked, revoke_and_ack, commitment_update, order)
6343                         }
6344                 }
6345         }
6346
6347         /// pending_htlc_adds includes both the holding cell and in-flight update_add_htlcs, whereas
6348         /// for claims/fails they are separated out.
6349         fn reconnect_nodes(node_a: &Node, node_b: &Node, send_funding_locked: (bool, 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)) {
6350                 node_a.node.peer_connected(&node_b.node.get_our_node_id());
6351                 let reestablish_1 = get_chan_reestablish_msgs!(node_a, node_b);
6352                 node_b.node.peer_connected(&node_a.node.get_our_node_id());
6353                 let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
6354
6355                 if send_funding_locked.0 {
6356                         // If a expects a funding_locked, it better not think it has received a revoke_and_ack
6357                         // from b
6358                         for reestablish in reestablish_1.iter() {
6359                                 assert_eq!(reestablish.next_remote_commitment_number, 0);
6360                         }
6361                 }
6362                 if send_funding_locked.1 {
6363                         // If b expects a funding_locked, it better not think it has received a revoke_and_ack
6364                         // from a
6365                         for reestablish in reestablish_2.iter() {
6366                                 assert_eq!(reestablish.next_remote_commitment_number, 0);
6367                         }
6368                 }
6369                 if send_funding_locked.0 || send_funding_locked.1 {
6370                         // If we expect any funding_locked's, both sides better have set
6371                         // next_local_commitment_number to 1
6372                         for reestablish in reestablish_1.iter() {
6373                                 assert_eq!(reestablish.next_local_commitment_number, 1);
6374                         }
6375                         for reestablish in reestablish_2.iter() {
6376                                 assert_eq!(reestablish.next_local_commitment_number, 1);
6377                         }
6378                 }
6379
6380                 let mut resp_1 = Vec::new();
6381                 for msg in reestablish_1 {
6382                         node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap();
6383                         resp_1.push(handle_chan_reestablish_msgs!(node_b, node_a));
6384                 }
6385                 if pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
6386                         check_added_monitors!(node_b, 1);
6387                 } else {
6388                         check_added_monitors!(node_b, 0);
6389                 }
6390
6391                 let mut resp_2 = Vec::new();
6392                 for msg in reestablish_2 {
6393                         node_a.node.handle_channel_reestablish(&node_b.node.get_our_node_id(), &msg).unwrap();
6394                         resp_2.push(handle_chan_reestablish_msgs!(node_a, node_b));
6395                 }
6396                 if pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
6397                         check_added_monitors!(node_a, 1);
6398                 } else {
6399                         check_added_monitors!(node_a, 0);
6400                 }
6401
6402                 // We dont yet support both needing updates, as that would require a different commitment dance:
6403                 assert!((pending_htlc_adds.0 == 0 && pending_htlc_claims.0 == 0 && pending_cell_htlc_claims.0 == 0 && pending_cell_htlc_fails.0 == 0) ||
6404                         (pending_htlc_adds.1 == 0 && pending_htlc_claims.1 == 0 && pending_cell_htlc_claims.1 == 0 && pending_cell_htlc_fails.1 == 0));
6405
6406                 for chan_msgs in resp_1.drain(..) {
6407                         if send_funding_locked.0 {
6408                                 node_a.node.handle_funding_locked(&node_b.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
6409                                 let announcement_event = node_a.node.get_and_clear_pending_msg_events();
6410                                 if !announcement_event.is_empty() {
6411                                         assert_eq!(announcement_event.len(), 1);
6412                                         if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
6413                                                 //TODO: Test announcement_sigs re-sending
6414                                         } else { panic!("Unexpected event!"); }
6415                                 }
6416                         } else {
6417                                 assert!(chan_msgs.0.is_none());
6418                         }
6419                         if pending_raa.0 {
6420                                 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
6421                                 node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
6422                                 assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
6423                                 check_added_monitors!(node_a, 1);
6424                         } else {
6425                                 assert!(chan_msgs.1.is_none());
6426                         }
6427                         if pending_htlc_adds.0 != 0 || pending_htlc_claims.0 != 0 || pending_cell_htlc_claims.0 != 0 || pending_cell_htlc_fails.0 != 0 {
6428                                 let commitment_update = chan_msgs.2.unwrap();
6429                                 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
6430                                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.0 as usize);
6431                                 } else {
6432                                         assert!(commitment_update.update_add_htlcs.is_empty());
6433                                 }
6434                                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
6435                                 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
6436                                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
6437                                 for update_add in commitment_update.update_add_htlcs {
6438                                         node_a.node.handle_update_add_htlc(&node_b.node.get_our_node_id(), &update_add).unwrap();
6439                                 }
6440                                 for update_fulfill in commitment_update.update_fulfill_htlcs {
6441                                         node_a.node.handle_update_fulfill_htlc(&node_b.node.get_our_node_id(), &update_fulfill).unwrap();
6442                                 }
6443                                 for update_fail in commitment_update.update_fail_htlcs {
6444                                         node_a.node.handle_update_fail_htlc(&node_b.node.get_our_node_id(), &update_fail).unwrap();
6445                                 }
6446
6447                                 if pending_htlc_adds.0 != -1 { // We use -1 to denote a response commitment_signed
6448                                         commitment_signed_dance!(node_a, node_b, commitment_update.commitment_signed, false);
6449                                 } else {
6450                                         node_a.node.handle_commitment_signed(&node_b.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
6451                                         check_added_monitors!(node_a, 1);
6452                                         let as_revoke_and_ack = get_event_msg!(node_a, MessageSendEvent::SendRevokeAndACK, node_b.node.get_our_node_id());
6453                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
6454                                         node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6455                                         assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
6456                                         check_added_monitors!(node_b, 1);
6457                                 }
6458                         } else {
6459                                 assert!(chan_msgs.2.is_none());
6460                         }
6461                 }
6462
6463                 for chan_msgs in resp_2.drain(..) {
6464                         if send_funding_locked.1 {
6465                                 node_b.node.handle_funding_locked(&node_a.node.get_our_node_id(), &chan_msgs.0.unwrap()).unwrap();
6466                                 let announcement_event = node_b.node.get_and_clear_pending_msg_events();
6467                                 if !announcement_event.is_empty() {
6468                                         assert_eq!(announcement_event.len(), 1);
6469                                         if let MessageSendEvent::SendAnnouncementSignatures { .. } = announcement_event[0] {
6470                                                 //TODO: Test announcement_sigs re-sending
6471                                         } else { panic!("Unexpected event!"); }
6472                                 }
6473                         } else {
6474                                 assert!(chan_msgs.0.is_none());
6475                         }
6476                         if pending_raa.1 {
6477                                 assert!(chan_msgs.3 == RAACommitmentOrder::RevokeAndACKFirst);
6478                                 node_b.node.handle_revoke_and_ack(&node_a.node.get_our_node_id(), &chan_msgs.1.unwrap()).unwrap();
6479                                 assert!(node_b.node.get_and_clear_pending_msg_events().is_empty());
6480                                 check_added_monitors!(node_b, 1);
6481                         } else {
6482                                 assert!(chan_msgs.1.is_none());
6483                         }
6484                         if pending_htlc_adds.1 != 0 || pending_htlc_claims.1 != 0 || pending_cell_htlc_claims.1 != 0 || pending_cell_htlc_fails.1 != 0 {
6485                                 let commitment_update = chan_msgs.2.unwrap();
6486                                 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
6487                                         assert_eq!(commitment_update.update_add_htlcs.len(), pending_htlc_adds.1 as usize);
6488                                 }
6489                                 assert_eq!(commitment_update.update_fulfill_htlcs.len(), pending_htlc_claims.0 + pending_cell_htlc_claims.0);
6490                                 assert_eq!(commitment_update.update_fail_htlcs.len(), pending_cell_htlc_fails.0);
6491                                 assert!(commitment_update.update_fail_malformed_htlcs.is_empty());
6492                                 for update_add in commitment_update.update_add_htlcs {
6493                                         node_b.node.handle_update_add_htlc(&node_a.node.get_our_node_id(), &update_add).unwrap();
6494                                 }
6495                                 for update_fulfill in commitment_update.update_fulfill_htlcs {
6496                                         node_b.node.handle_update_fulfill_htlc(&node_a.node.get_our_node_id(), &update_fulfill).unwrap();
6497                                 }
6498                                 for update_fail in commitment_update.update_fail_htlcs {
6499                                         node_b.node.handle_update_fail_htlc(&node_a.node.get_our_node_id(), &update_fail).unwrap();
6500                                 }
6501
6502                                 if pending_htlc_adds.1 != -1 { // We use -1 to denote a response commitment_signed
6503                                         commitment_signed_dance!(node_b, node_a, commitment_update.commitment_signed, false);
6504                                 } else {
6505                                         node_b.node.handle_commitment_signed(&node_a.node.get_our_node_id(), &commitment_update.commitment_signed).unwrap();
6506                                         check_added_monitors!(node_b, 1);
6507                                         let bs_revoke_and_ack = get_event_msg!(node_b, MessageSendEvent::SendRevokeAndACK, node_a.node.get_our_node_id());
6508                                         // No commitment_signed so get_event_msg's assert(len == 1) passes
6509                                         node_a.node.handle_revoke_and_ack(&node_b.node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6510                                         assert!(node_a.node.get_and_clear_pending_msg_events().is_empty());
6511                                         check_added_monitors!(node_a, 1);
6512                                 }
6513                         } else {
6514                                 assert!(chan_msgs.2.is_none());
6515                         }
6516                 }
6517         }
6518
6519         #[test]
6520         fn test_simple_peer_disconnect() {
6521                 // Test that we can reconnect when there are no lost messages
6522                 let nodes = create_network(3);
6523                 create_announced_chan_between_nodes(&nodes, 0, 1);
6524                 create_announced_chan_between_nodes(&nodes, 1, 2);
6525
6526                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6527                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6528                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6529
6530                 let payment_preimage_1 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
6531                 let payment_hash_2 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
6532                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_2);
6533                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_1);
6534
6535                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6536                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6537                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6538
6539                 let payment_preimage_3 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
6540                 let payment_preimage_4 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).0;
6541                 let payment_hash_5 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
6542                 let payment_hash_6 = route_payment(&nodes[0], &vec!(&nodes[1], &nodes[2])[..], 1000000).1;
6543
6544                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6545                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6546
6547                 claim_payment_along_route(&nodes[0], &vec!(&nodes[1], &nodes[2]), true, payment_preimage_3);
6548                 fail_payment_along_route(&nodes[0], &[&nodes[1], &nodes[2]], true, payment_hash_5);
6549
6550                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (1, 0), (1, 0), (false, false));
6551                 {
6552                         let events = nodes[0].node.get_and_clear_pending_events();
6553                         assert_eq!(events.len(), 2);
6554                         match events[0] {
6555                                 Event::PaymentSent { payment_preimage } => {
6556                                         assert_eq!(payment_preimage, payment_preimage_3);
6557                                 },
6558                                 _ => panic!("Unexpected event"),
6559                         }
6560                         match events[1] {
6561                                 Event::PaymentFailed { payment_hash, rejected_by_dest } => {
6562                                         assert_eq!(payment_hash, payment_hash_5);
6563                                         assert!(rejected_by_dest);
6564                                 },
6565                                 _ => panic!("Unexpected event"),
6566                         }
6567                 }
6568
6569                 claim_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_preimage_4);
6570                 fail_payment(&nodes[0], &vec!(&nodes[1], &nodes[2]), payment_hash_6);
6571         }
6572
6573         fn do_test_drop_messages_peer_disconnect(messages_delivered: u8) {
6574                 // Test that we can reconnect when in-flight HTLC updates get dropped
6575                 let mut nodes = create_network(2);
6576                 if messages_delivered == 0 {
6577                         create_chan_between_nodes_with_value_a(&nodes[0], &nodes[1], 100000, 10001);
6578                         // nodes[1] doesn't receive the funding_locked message (it'll be re-sent on reconnect)
6579                 } else {
6580                         create_announced_chan_between_nodes(&nodes, 0, 1);
6581                 }
6582
6583                 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();
6584                 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6585
6586                 let payment_event = {
6587                         nodes[0].node.send_payment(route.clone(), payment_hash_1).unwrap();
6588                         check_added_monitors!(nodes[0], 1);
6589
6590                         let mut events = nodes[0].node.get_and_clear_pending_msg_events();
6591                         assert_eq!(events.len(), 1);
6592                         SendEvent::from_event(events.remove(0))
6593                 };
6594                 assert_eq!(nodes[1].node.get_our_node_id(), payment_event.node_id);
6595
6596                 if messages_delivered < 2 {
6597                         // Drop the payment_event messages, and let them get re-generated in reconnect_nodes!
6598                 } else {
6599                         nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
6600                         if messages_delivered >= 3 {
6601                                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
6602                                 check_added_monitors!(nodes[1], 1);
6603                                 let (bs_revoke_and_ack, bs_commitment_signed) = get_revoke_commit_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6604
6605                                 if messages_delivered >= 4 {
6606                                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6607                                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6608                                         check_added_monitors!(nodes[0], 1);
6609
6610                                         if messages_delivered >= 5 {
6611                                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_commitment_signed).unwrap();
6612                                                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6613                                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6614                                                 check_added_monitors!(nodes[0], 1);
6615
6616                                                 if messages_delivered >= 6 {
6617                                                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6618                                                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6619                                                         check_added_monitors!(nodes[1], 1);
6620                                                 }
6621                                         }
6622                                 }
6623                         }
6624                 }
6625
6626                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6627                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6628                 if messages_delivered < 3 {
6629                         // Even if the funding_locked messages get exchanged, as long as nothing further was
6630                         // received on either side, both sides will need to resend them.
6631                         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 1), (0, 0), (0, 0), (0, 0), (false, false));
6632                 } else if messages_delivered == 3 {
6633                         // nodes[0] still wants its RAA + commitment_signed
6634                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (true, false));
6635                 } else if messages_delivered == 4 {
6636                         // nodes[0] still wants its commitment_signed
6637                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (-1, 0), (0, 0), (0, 0), (0, 0), (false, false));
6638                 } else if messages_delivered == 5 {
6639                         // nodes[1] still wants its final RAA
6640                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, true));
6641                 } else if messages_delivered == 6 {
6642                         // Everything was delivered...
6643                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6644                 }
6645
6646                 let events_1 = nodes[1].node.get_and_clear_pending_events();
6647                 assert_eq!(events_1.len(), 1);
6648                 match events_1[0] {
6649                         Event::PendingHTLCsForwardable { .. } => { },
6650                         _ => panic!("Unexpected event"),
6651                 };
6652
6653                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6654                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6655                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6656
6657                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
6658                 nodes[1].node.process_pending_htlc_forwards();
6659
6660                 let events_2 = nodes[1].node.get_and_clear_pending_events();
6661                 assert_eq!(events_2.len(), 1);
6662                 match events_2[0] {
6663                         Event::PaymentReceived { ref payment_hash, amt } => {
6664                                 assert_eq!(payment_hash_1, *payment_hash);
6665                                 assert_eq!(amt, 1000000);
6666                         },
6667                         _ => panic!("Unexpected event"),
6668                 }
6669
6670                 nodes[1].node.claim_funds(payment_preimage_1);
6671                 check_added_monitors!(nodes[1], 1);
6672
6673                 let events_3 = nodes[1].node.get_and_clear_pending_msg_events();
6674                 assert_eq!(events_3.len(), 1);
6675                 let (update_fulfill_htlc, commitment_signed) = match events_3[0] {
6676                         MessageSendEvent::UpdateHTLCs { ref node_id, ref updates } => {
6677                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6678                                 assert!(updates.update_add_htlcs.is_empty());
6679                                 assert!(updates.update_fail_htlcs.is_empty());
6680                                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
6681                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
6682                                 assert!(updates.update_fee.is_none());
6683                                 (updates.update_fulfill_htlcs[0].clone(), updates.commitment_signed.clone())
6684                         },
6685                         _ => panic!("Unexpected event"),
6686                 };
6687
6688                 if messages_delivered >= 1 {
6689                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlc).unwrap();
6690
6691                         let events_4 = nodes[0].node.get_and_clear_pending_events();
6692                         assert_eq!(events_4.len(), 1);
6693                         match events_4[0] {
6694                                 Event::PaymentSent { ref payment_preimage } => {
6695                                         assert_eq!(payment_preimage_1, *payment_preimage);
6696                                 },
6697                                 _ => panic!("Unexpected event"),
6698                         }
6699
6700                         if messages_delivered >= 2 {
6701                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &commitment_signed).unwrap();
6702                                 check_added_monitors!(nodes[0], 1);
6703                                 let (as_revoke_and_ack, as_commitment_signed) = get_revoke_commit_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6704
6705                                 if messages_delivered >= 3 {
6706                                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6707                                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6708                                         check_added_monitors!(nodes[1], 1);
6709
6710                                         if messages_delivered >= 4 {
6711                                                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed).unwrap();
6712                                                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6713                                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6714                                                 check_added_monitors!(nodes[1], 1);
6715
6716                                                 if messages_delivered >= 5 {
6717                                                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6718                                                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6719                                                         check_added_monitors!(nodes[0], 1);
6720                                                 }
6721                                         }
6722                                 }
6723                         }
6724                 }
6725
6726                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6727                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6728                 if messages_delivered < 2 {
6729                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (1, 0), (0, 0), (0, 0), (false, false));
6730                         //TODO: Deduplicate PaymentSent events, then enable this if:
6731                         //if messages_delivered < 1 {
6732                                 let events_4 = nodes[0].node.get_and_clear_pending_events();
6733                                 assert_eq!(events_4.len(), 1);
6734                                 match events_4[0] {
6735                                         Event::PaymentSent { ref payment_preimage } => {
6736                                                 assert_eq!(payment_preimage_1, *payment_preimage);
6737                                         },
6738                                         _ => panic!("Unexpected event"),
6739                                 }
6740                         //}
6741                 } else if messages_delivered == 2 {
6742                         // nodes[0] still wants its RAA + commitment_signed
6743                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, true));
6744                 } else if messages_delivered == 3 {
6745                         // nodes[0] still wants its commitment_signed
6746                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, -1), (0, 0), (0, 0), (0, 0), (false, false));
6747                 } else if messages_delivered == 4 {
6748                         // nodes[1] still wants its final RAA
6749                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (true, false));
6750                 } else if messages_delivered == 5 {
6751                         // Everything was delivered...
6752                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6753                 }
6754
6755                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6756                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6757                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6758
6759                 // Channel should still work fine...
6760                 let payment_preimage_2 = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000).0;
6761                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
6762         }
6763
6764         #[test]
6765         fn test_drop_messages_peer_disconnect_a() {
6766                 do_test_drop_messages_peer_disconnect(0);
6767                 do_test_drop_messages_peer_disconnect(1);
6768                 do_test_drop_messages_peer_disconnect(2);
6769                 do_test_drop_messages_peer_disconnect(3);
6770         }
6771
6772         #[test]
6773         fn test_drop_messages_peer_disconnect_b() {
6774                 do_test_drop_messages_peer_disconnect(4);
6775                 do_test_drop_messages_peer_disconnect(5);
6776                 do_test_drop_messages_peer_disconnect(6);
6777         }
6778
6779         #[test]
6780         fn test_funding_peer_disconnect() {
6781                 // Test that we can lock in our funding tx while disconnected
6782                 let nodes = create_network(2);
6783                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
6784
6785                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6786                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6787
6788                 confirm_transaction(&nodes[0].chain_monitor, &tx, tx.version);
6789                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
6790                 assert_eq!(events_1.len(), 1);
6791                 match events_1[0] {
6792                         MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
6793                                 assert_eq!(*node_id, nodes[1].node.get_our_node_id());
6794                         },
6795                         _ => panic!("Unexpected event"),
6796                 }
6797
6798                 reconnect_nodes(&nodes[0], &nodes[1], (false, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6799
6800                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6801                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6802
6803                 confirm_transaction(&nodes[1].chain_monitor, &tx, tx.version);
6804                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6805                 assert_eq!(events_2.len(), 2);
6806                 match events_2[0] {
6807                         MessageSendEvent::SendFundingLocked { ref node_id, msg: _ } => {
6808                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6809                         },
6810                         _ => panic!("Unexpected event"),
6811                 }
6812                 match events_2[1] {
6813                         MessageSendEvent::SendAnnouncementSignatures { ref node_id, msg: _ } => {
6814                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6815                         },
6816                         _ => panic!("Unexpected event"),
6817                 }
6818
6819                 reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
6820
6821                 // TODO: We shouldn't need to manually pass list_usable_chanels here once we support
6822                 // rebroadcasting announcement_signatures upon reconnect.
6823
6824                 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();
6825                 let (payment_preimage, _) = send_along_route(&nodes[0], route, &[&nodes[1]], 1000000);
6826                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
6827         }
6828
6829         #[test]
6830         fn test_drop_messages_peer_disconnect_dual_htlc() {
6831                 // Test that we can handle reconnecting when both sides of a channel have pending
6832                 // commitment_updates when we disconnect.
6833                 let mut nodes = create_network(2);
6834                 create_announced_chan_between_nodes(&nodes, 0, 1);
6835
6836                 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
6837
6838                 // Now try to send a second payment which will fail to send
6839                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6840                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
6841
6842                 nodes[0].node.send_payment(route.clone(), payment_hash_2).unwrap();
6843                 check_added_monitors!(nodes[0], 1);
6844
6845                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
6846                 assert_eq!(events_1.len(), 1);
6847                 match events_1[0] {
6848                         MessageSendEvent::UpdateHTLCs { .. } => {},
6849                         _ => panic!("Unexpected event"),
6850                 }
6851
6852                 assert!(nodes[1].node.claim_funds(payment_preimage_1));
6853                 check_added_monitors!(nodes[1], 1);
6854
6855                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
6856                 assert_eq!(events_2.len(), 1);
6857                 match events_2[0] {
6858                         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 } } => {
6859                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
6860                                 assert!(update_add_htlcs.is_empty());
6861                                 assert_eq!(update_fulfill_htlcs.len(), 1);
6862                                 assert!(update_fail_htlcs.is_empty());
6863                                 assert!(update_fail_malformed_htlcs.is_empty());
6864                                 assert!(update_fee.is_none());
6865
6866                                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
6867                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
6868                                 assert_eq!(events_3.len(), 1);
6869                                 match events_3[0] {
6870                                         Event::PaymentSent { ref payment_preimage } => {
6871                                                 assert_eq!(*payment_preimage, payment_preimage_1);
6872                                         },
6873                                         _ => panic!("Unexpected event"),
6874                                 }
6875
6876                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), commitment_signed).unwrap();
6877                                 let _ = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6878                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6879                                 check_added_monitors!(nodes[0], 1);
6880                         },
6881                         _ => panic!("Unexpected event"),
6882                 }
6883
6884                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
6885                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
6886
6887                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
6888                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
6889                 assert_eq!(reestablish_1.len(), 1);
6890                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
6891                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
6892                 assert_eq!(reestablish_2.len(), 1);
6893
6894                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
6895                 let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
6896                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
6897                 let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
6898
6899                 assert!(as_resp.0.is_none());
6900                 assert!(bs_resp.0.is_none());
6901
6902                 assert!(bs_resp.1.is_none());
6903                 assert!(bs_resp.2.is_none());
6904
6905                 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
6906
6907                 assert_eq!(as_resp.2.as_ref().unwrap().update_add_htlcs.len(), 1);
6908                 assert!(as_resp.2.as_ref().unwrap().update_fulfill_htlcs.is_empty());
6909                 assert!(as_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
6910                 assert!(as_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
6911                 assert!(as_resp.2.as_ref().unwrap().update_fee.is_none());
6912                 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();
6913                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_resp.2.as_ref().unwrap().commitment_signed).unwrap();
6914                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6915                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6916                 check_added_monitors!(nodes[1], 1);
6917
6918                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), as_resp.1.as_ref().unwrap()).unwrap();
6919                 let bs_second_commitment_signed = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
6920                 assert!(bs_second_commitment_signed.update_add_htlcs.is_empty());
6921                 assert!(bs_second_commitment_signed.update_fulfill_htlcs.is_empty());
6922                 assert!(bs_second_commitment_signed.update_fail_htlcs.is_empty());
6923                 assert!(bs_second_commitment_signed.update_fail_malformed_htlcs.is_empty());
6924                 assert!(bs_second_commitment_signed.update_fee.is_none());
6925                 check_added_monitors!(nodes[1], 1);
6926
6927                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
6928                 let as_commitment_signed = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
6929                 assert!(as_commitment_signed.update_add_htlcs.is_empty());
6930                 assert!(as_commitment_signed.update_fulfill_htlcs.is_empty());
6931                 assert!(as_commitment_signed.update_fail_htlcs.is_empty());
6932                 assert!(as_commitment_signed.update_fail_malformed_htlcs.is_empty());
6933                 assert!(as_commitment_signed.update_fee.is_none());
6934                 check_added_monitors!(nodes[0], 1);
6935
6936                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_signed.commitment_signed).unwrap();
6937                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
6938                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6939                 check_added_monitors!(nodes[0], 1);
6940
6941                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_signed.commitment_signed).unwrap();
6942                 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
6943                 // No commitment_signed so get_event_msg's assert(len == 1) passes
6944                 check_added_monitors!(nodes[1], 1);
6945
6946                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
6947                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
6948                 check_added_monitors!(nodes[1], 1);
6949
6950                 let events_4 = nodes[1].node.get_and_clear_pending_events();
6951                 assert_eq!(events_4.len(), 1);
6952                 match events_4[0] {
6953                         Event::PendingHTLCsForwardable { .. } => { },
6954                         _ => panic!("Unexpected event"),
6955                 };
6956
6957                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
6958                 nodes[1].node.process_pending_htlc_forwards();
6959
6960                 let events_5 = nodes[1].node.get_and_clear_pending_events();
6961                 assert_eq!(events_5.len(), 1);
6962                 match events_5[0] {
6963                         Event::PaymentReceived { ref payment_hash, amt: _ } => {
6964                                 assert_eq!(payment_hash_2, *payment_hash);
6965                         },
6966                         _ => panic!("Unexpected event"),
6967                 }
6968
6969                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
6970                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
6971                 check_added_monitors!(nodes[0], 1);
6972
6973                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
6974         }
6975
6976         #[test]
6977         fn test_simple_monitor_permanent_update_fail() {
6978                 // Test that we handle a simple permanent monitor update failure
6979                 let mut nodes = create_network(2);
6980                 create_announced_chan_between_nodes(&nodes, 0, 1);
6981
6982                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
6983                 let (_, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
6984
6985                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
6986                 if let Err(APIError::ChannelUnavailable {..}) = nodes[0].node.send_payment(route, payment_hash_1) {} else { panic!(); }
6987                 check_added_monitors!(nodes[0], 1);
6988
6989                 let events_1 = nodes[0].node.get_and_clear_pending_msg_events();
6990                 assert_eq!(events_1.len(), 2);
6991                 match events_1[0] {
6992                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
6993                         _ => panic!("Unexpected event"),
6994                 };
6995                 match events_1[1] {
6996                         MessageSendEvent::HandleError { node_id, .. } => assert_eq!(node_id, nodes[1].node.get_our_node_id()),
6997                         _ => panic!("Unexpected event"),
6998                 };
6999
7000                 // TODO: Once we hit the chain with the failure transaction we should check that we get a
7001                 // PaymentFailed event
7002
7003                 assert_eq!(nodes[0].node.list_channels().len(), 0);
7004         }
7005
7006         fn do_test_simple_monitor_temporary_update_fail(disconnect: bool) {
7007                 // Test that we can recover from a simple temporary monitor update failure optionally with
7008                 // a disconnect in between
7009                 let mut nodes = create_network(2);
7010                 create_announced_chan_between_nodes(&nodes, 0, 1);
7011
7012                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7013                 let (payment_preimage_1, payment_hash_1) = get_payment_preimage_hash!(nodes[0]);
7014
7015                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7016                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_1) {} else { panic!(); }
7017                 check_added_monitors!(nodes[0], 1);
7018
7019                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
7020                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7021                 assert_eq!(nodes[0].node.list_channels().len(), 1);
7022
7023                 if disconnect {
7024                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7025                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7026                         reconnect_nodes(&nodes[0], &nodes[1], (true, true), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7027                 }
7028
7029                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
7030                 nodes[0].node.test_restore_channel_monitor();
7031                 check_added_monitors!(nodes[0], 1);
7032
7033                 let mut events_2 = nodes[0].node.get_and_clear_pending_msg_events();
7034                 assert_eq!(events_2.len(), 1);
7035                 let payment_event = SendEvent::from_event(events_2.pop().unwrap());
7036                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
7037                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
7038                 commitment_signed_dance!(nodes[1], nodes[0], payment_event.commitment_msg, false);
7039
7040                 expect_pending_htlcs_forwardable!(nodes[1]);
7041
7042                 let events_3 = nodes[1].node.get_and_clear_pending_events();
7043                 assert_eq!(events_3.len(), 1);
7044                 match events_3[0] {
7045                         Event::PaymentReceived { ref payment_hash, amt } => {
7046                                 assert_eq!(payment_hash_1, *payment_hash);
7047                                 assert_eq!(amt, 1000000);
7048                         },
7049                         _ => panic!("Unexpected event"),
7050                 }
7051
7052                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_1);
7053
7054                 // Now set it to failed again...
7055                 let (_, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
7056                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7057                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route, payment_hash_2) {} else { panic!(); }
7058                 check_added_monitors!(nodes[0], 1);
7059
7060                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
7061                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7062                 assert_eq!(nodes[0].node.list_channels().len(), 1);
7063
7064                 if disconnect {
7065                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7066                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7067                         reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
7068                 }
7069
7070                 // ...and make sure we can force-close a TemporaryFailure channel with a PermanentFailure
7071                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::PermanentFailure);
7072                 nodes[0].node.test_restore_channel_monitor();
7073                 check_added_monitors!(nodes[0], 1);
7074
7075                 let events_5 = nodes[0].node.get_and_clear_pending_msg_events();
7076                 assert_eq!(events_5.len(), 1);
7077                 match events_5[0] {
7078                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
7079                         _ => panic!("Unexpected event"),
7080                 }
7081
7082                 // TODO: Once we hit the chain with the failure transaction we should check that we get a
7083                 // PaymentFailed event
7084
7085                 assert_eq!(nodes[0].node.list_channels().len(), 0);
7086         }
7087
7088         #[test]
7089         fn test_simple_monitor_temporary_update_fail() {
7090                 do_test_simple_monitor_temporary_update_fail(false);
7091                 do_test_simple_monitor_temporary_update_fail(true);
7092         }
7093
7094         fn do_test_monitor_temporary_update_fail(disconnect_count: usize) {
7095                 let disconnect_flags = 8 | 16;
7096
7097                 // Test that we can recover from a temporary monitor update failure with some in-flight
7098                 // HTLCs going on at the same time potentially with some disconnection thrown in.
7099                 // * First we route a payment, then get a temporary monitor update failure when trying to
7100                 //   route a second payment. We then claim the first payment.
7101                 // * If disconnect_count is set, we will disconnect at this point (which is likely as
7102                 //   TemporaryFailure likely indicates net disconnect which resulted in failing to update
7103                 //   the ChannelMonitor on a watchtower).
7104                 // * If !(disconnect_count & 16) we deliver a update_fulfill_htlc/CS for the first payment
7105                 //   immediately, otherwise we wait sconnect and deliver them via the reconnect
7106                 //   channel_reestablish processing (ie disconnect_count & 16 makes no sense if
7107                 //   disconnect_count & !disconnect_flags is 0).
7108                 // * We then update the channel monitor, reconnecting if disconnect_count is set and walk
7109                 //   through message sending, potentially disconnect/reconnecting multiple times based on
7110                 //   disconnect_count, to get the update_fulfill_htlc through.
7111                 // * We then walk through more message exchanges to get the original update_add_htlc
7112                 //   through, swapping message ordering based on disconnect_count & 8 and optionally
7113                 //   disconnect/reconnecting based on disconnect_count.
7114                 let mut nodes = create_network(2);
7115                 create_announced_chan_between_nodes(&nodes, 0, 1);
7116
7117                 let (payment_preimage_1, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
7118
7119                 // Now try to send a second payment which will fail to send
7120                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7121                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
7122
7123                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7124                 if let Err(APIError::MonitorUpdateFailed) = nodes[0].node.send_payment(route.clone(), payment_hash_2) {} else { panic!(); }
7125                 check_added_monitors!(nodes[0], 1);
7126
7127                 assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
7128                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7129                 assert_eq!(nodes[0].node.list_channels().len(), 1);
7130
7131                 // Claim the previous payment, which will result in a update_fulfill_htlc/CS from nodes[1]
7132                 // but nodes[0] won't respond since it is frozen.
7133                 assert!(nodes[1].node.claim_funds(payment_preimage_1));
7134                 check_added_monitors!(nodes[1], 1);
7135                 let events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7136                 assert_eq!(events_2.len(), 1);
7137                 let (bs_initial_fulfill, bs_initial_commitment_signed) = match events_2[0] {
7138                         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 } } => {
7139                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7140                                 assert!(update_add_htlcs.is_empty());
7141                                 assert_eq!(update_fulfill_htlcs.len(), 1);
7142                                 assert!(update_fail_htlcs.is_empty());
7143                                 assert!(update_fail_malformed_htlcs.is_empty());
7144                                 assert!(update_fee.is_none());
7145
7146                                 if (disconnect_count & 16) == 0 {
7147                                         nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &update_fulfill_htlcs[0]).unwrap();
7148                                         let events_3 = nodes[0].node.get_and_clear_pending_events();
7149                                         assert_eq!(events_3.len(), 1);
7150                                         match events_3[0] {
7151                                                 Event::PaymentSent { ref payment_preimage } => {
7152                                                         assert_eq!(*payment_preimage, payment_preimage_1);
7153                                                 },
7154                                                 _ => panic!("Unexpected event"),
7155                                         }
7156
7157                                         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) {
7158                                                 assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
7159                                         } else { panic!(); }
7160                                 }
7161
7162                                 (update_fulfill_htlcs[0].clone(), commitment_signed.clone())
7163                         },
7164                         _ => panic!("Unexpected event"),
7165                 };
7166
7167                 if disconnect_count & !disconnect_flags > 0 {
7168                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7169                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7170                 }
7171
7172                 // Now fix monitor updating...
7173                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
7174                 nodes[0].node.test_restore_channel_monitor();
7175                 check_added_monitors!(nodes[0], 1);
7176
7177                 macro_rules! disconnect_reconnect_peers { () => { {
7178                         nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7179                         nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7180
7181                         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7182                         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7183                         assert_eq!(reestablish_1.len(), 1);
7184                         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7185                         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7186                         assert_eq!(reestablish_2.len(), 1);
7187
7188                         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
7189                         let as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7190                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
7191                         let bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7192
7193                         assert!(as_resp.0.is_none());
7194                         assert!(bs_resp.0.is_none());
7195
7196                         (reestablish_1, reestablish_2, as_resp, bs_resp)
7197                 } } }
7198
7199                 let (payment_event, initial_revoke_and_ack) = if disconnect_count & !disconnect_flags > 0 {
7200                         assert!(nodes[0].node.get_and_clear_pending_events().is_empty());
7201                         assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7202
7203                         nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7204                         let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7205                         assert_eq!(reestablish_1.len(), 1);
7206                         nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7207                         let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7208                         assert_eq!(reestablish_2.len(), 1);
7209
7210                         nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
7211                         check_added_monitors!(nodes[0], 0);
7212                         let mut as_resp = handle_chan_reestablish_msgs!(nodes[0], nodes[1]);
7213                         nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
7214                         check_added_monitors!(nodes[1], 0);
7215                         let mut bs_resp = handle_chan_reestablish_msgs!(nodes[1], nodes[0]);
7216
7217                         assert!(as_resp.0.is_none());
7218                         assert!(bs_resp.0.is_none());
7219
7220                         assert!(bs_resp.1.is_none());
7221                         if (disconnect_count & 16) == 0 {
7222                                 assert!(bs_resp.2.is_none());
7223
7224                                 assert!(as_resp.1.is_some());
7225                                 assert!(as_resp.2.is_some());
7226                                 assert!(as_resp.3 == RAACommitmentOrder::CommitmentFirst);
7227                         } else {
7228                                 assert!(bs_resp.2.as_ref().unwrap().update_add_htlcs.is_empty());
7229                                 assert!(bs_resp.2.as_ref().unwrap().update_fail_htlcs.is_empty());
7230                                 assert!(bs_resp.2.as_ref().unwrap().update_fail_malformed_htlcs.is_empty());
7231                                 assert!(bs_resp.2.as_ref().unwrap().update_fee.is_none());
7232                                 assert!(bs_resp.2.as_ref().unwrap().update_fulfill_htlcs == vec![bs_initial_fulfill]);
7233                                 assert!(bs_resp.2.as_ref().unwrap().commitment_signed == bs_initial_commitment_signed);
7234
7235                                 assert!(as_resp.1.is_none());
7236
7237                                 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();
7238                                 let events_3 = nodes[0].node.get_and_clear_pending_events();
7239                                 assert_eq!(events_3.len(), 1);
7240                                 match events_3[0] {
7241                                         Event::PaymentSent { ref payment_preimage } => {
7242                                                 assert_eq!(*payment_preimage, payment_preimage_1);
7243                                         },
7244                                         _ => panic!("Unexpected event"),
7245                                 }
7246
7247                                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_resp.2.as_ref().unwrap().commitment_signed).unwrap();
7248                                 let as_resp_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7249                                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7250                                 check_added_monitors!(nodes[0], 1);
7251
7252                                 as_resp.1 = Some(as_resp_raa);
7253                                 bs_resp.2 = None;
7254                         }
7255
7256                         if disconnect_count & !disconnect_flags > 1 {
7257                                 let (second_reestablish_1, second_reestablish_2, second_as_resp, second_bs_resp) = disconnect_reconnect_peers!();
7258
7259                                 if (disconnect_count & 16) == 0 {
7260                                         assert!(reestablish_1 == second_reestablish_1);
7261                                         assert!(reestablish_2 == second_reestablish_2);
7262                                 }
7263                                 assert!(as_resp == second_as_resp);
7264                                 assert!(bs_resp == second_bs_resp);
7265                         }
7266
7267                         (SendEvent::from_commitment_update(nodes[1].node.get_our_node_id(), as_resp.2.unwrap()), as_resp.1.unwrap())
7268                 } else {
7269                         let mut events_4 = nodes[0].node.get_and_clear_pending_msg_events();
7270                         assert_eq!(events_4.len(), 2);
7271                         (SendEvent::from_event(events_4.remove(0)), match events_4[0] {
7272                                 MessageSendEvent::SendRevokeAndACK { ref node_id, ref msg } => {
7273                                         assert_eq!(*node_id, nodes[1].node.get_our_node_id());
7274                                         msg.clone()
7275                                 },
7276                                 _ => panic!("Unexpected event"),
7277                         })
7278                 };
7279
7280                 assert_eq!(payment_event.node_id, nodes[1].node.get_our_node_id());
7281
7282                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &payment_event.msgs[0]).unwrap();
7283                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &payment_event.commitment_msg).unwrap();
7284                 let bs_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7285                 // nodes[1] is awaiting an RAA from nodes[0] still so get_event_msg's assert(len == 1) passes
7286                 check_added_monitors!(nodes[1], 1);
7287
7288                 if disconnect_count & !disconnect_flags > 2 {
7289                         let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7290
7291                         assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
7292                         assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
7293
7294                         assert!(as_resp.2.is_none());
7295                         assert!(bs_resp.2.is_none());
7296                 }
7297
7298                 let as_commitment_update;
7299                 let bs_second_commitment_update;
7300
7301                 macro_rules! handle_bs_raa { () => {
7302                         nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
7303                         as_commitment_update = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
7304                         assert!(as_commitment_update.update_add_htlcs.is_empty());
7305                         assert!(as_commitment_update.update_fulfill_htlcs.is_empty());
7306                         assert!(as_commitment_update.update_fail_htlcs.is_empty());
7307                         assert!(as_commitment_update.update_fail_malformed_htlcs.is_empty());
7308                         assert!(as_commitment_update.update_fee.is_none());
7309                         check_added_monitors!(nodes[0], 1);
7310                 } }
7311
7312                 macro_rules! handle_initial_raa { () => {
7313                         nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &initial_revoke_and_ack).unwrap();
7314                         bs_second_commitment_update = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7315                         assert!(bs_second_commitment_update.update_add_htlcs.is_empty());
7316                         assert!(bs_second_commitment_update.update_fulfill_htlcs.is_empty());
7317                         assert!(bs_second_commitment_update.update_fail_htlcs.is_empty());
7318                         assert!(bs_second_commitment_update.update_fail_malformed_htlcs.is_empty());
7319                         assert!(bs_second_commitment_update.update_fee.is_none());
7320                         check_added_monitors!(nodes[1], 1);
7321                 } }
7322
7323                 if (disconnect_count & 8) == 0 {
7324                         handle_bs_raa!();
7325
7326                         if disconnect_count & !disconnect_flags > 3 {
7327                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7328
7329                                 assert!(as_resp.1.unwrap() == initial_revoke_and_ack);
7330                                 assert!(bs_resp.1.is_none());
7331
7332                                 assert!(as_resp.2.unwrap() == as_commitment_update);
7333                                 assert!(bs_resp.2.is_none());
7334
7335                                 assert!(as_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
7336                         }
7337
7338                         handle_initial_raa!();
7339
7340                         if disconnect_count & !disconnect_flags > 4 {
7341                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7342
7343                                 assert!(as_resp.1.is_none());
7344                                 assert!(bs_resp.1.is_none());
7345
7346                                 assert!(as_resp.2.unwrap() == as_commitment_update);
7347                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
7348                         }
7349                 } else {
7350                         handle_initial_raa!();
7351
7352                         if disconnect_count & !disconnect_flags > 3 {
7353                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7354
7355                                 assert!(as_resp.1.is_none());
7356                                 assert!(bs_resp.1.unwrap() == bs_revoke_and_ack);
7357
7358                                 assert!(as_resp.2.is_none());
7359                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
7360
7361                                 assert!(bs_resp.3 == RAACommitmentOrder::RevokeAndACKFirst);
7362                         }
7363
7364                         handle_bs_raa!();
7365
7366                         if disconnect_count & !disconnect_flags > 4 {
7367                                 let (_, _, as_resp, bs_resp) = disconnect_reconnect_peers!();
7368
7369                                 assert!(as_resp.1.is_none());
7370                                 assert!(bs_resp.1.is_none());
7371
7372                                 assert!(as_resp.2.unwrap() == as_commitment_update);
7373                                 assert!(bs_resp.2.unwrap() == bs_second_commitment_update);
7374                         }
7375                 }
7376
7377                 nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &bs_second_commitment_update.commitment_signed).unwrap();
7378                 let as_revoke_and_ack = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7379                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7380                 check_added_monitors!(nodes[0], 1);
7381
7382                 nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &as_commitment_update.commitment_signed).unwrap();
7383                 let bs_second_revoke_and_ack = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[0].node.get_our_node_id());
7384                 // No commitment_signed so get_event_msg's assert(len == 1) passes
7385                 check_added_monitors!(nodes[1], 1);
7386
7387                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &as_revoke_and_ack).unwrap();
7388                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7389                 check_added_monitors!(nodes[1], 1);
7390
7391                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &bs_second_revoke_and_ack).unwrap();
7392                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7393                 check_added_monitors!(nodes[0], 1);
7394
7395                 expect_pending_htlcs_forwardable!(nodes[1]);
7396
7397                 let events_5 = nodes[1].node.get_and_clear_pending_events();
7398                 assert_eq!(events_5.len(), 1);
7399                 match events_5[0] {
7400                         Event::PaymentReceived { ref payment_hash, amt } => {
7401                                 assert_eq!(payment_hash_2, *payment_hash);
7402                                 assert_eq!(amt, 1000000);
7403                         },
7404                         _ => panic!("Unexpected event"),
7405                 }
7406
7407                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage_2);
7408         }
7409
7410         #[test]
7411         fn test_monitor_temporary_update_fail_a() {
7412                 do_test_monitor_temporary_update_fail(0);
7413                 do_test_monitor_temporary_update_fail(1);
7414                 do_test_monitor_temporary_update_fail(2);
7415                 do_test_monitor_temporary_update_fail(3);
7416                 do_test_monitor_temporary_update_fail(4);
7417                 do_test_monitor_temporary_update_fail(5);
7418         }
7419
7420         #[test]
7421         fn test_monitor_temporary_update_fail_b() {
7422                 do_test_monitor_temporary_update_fail(2 | 8);
7423                 do_test_monitor_temporary_update_fail(3 | 8);
7424                 do_test_monitor_temporary_update_fail(4 | 8);
7425                 do_test_monitor_temporary_update_fail(5 | 8);
7426         }
7427
7428         #[test]
7429         fn test_monitor_temporary_update_fail_c() {
7430                 do_test_monitor_temporary_update_fail(1 | 16);
7431                 do_test_monitor_temporary_update_fail(2 | 16);
7432                 do_test_monitor_temporary_update_fail(3 | 16);
7433                 do_test_monitor_temporary_update_fail(2 | 8 | 16);
7434                 do_test_monitor_temporary_update_fail(3 | 8 | 16);
7435         }
7436
7437         #[test]
7438         fn test_monitor_update_fail_cs() {
7439                 // Tests handling of a monitor update failure when processing an incoming commitment_signed
7440                 let mut nodes = create_network(2);
7441                 create_announced_chan_between_nodes(&nodes, 0, 1);
7442
7443                 let route = nodes[0].router.get_route(&nodes[1].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7444                 let (payment_preimage, our_payment_hash) = get_payment_preimage_hash!(nodes[0]);
7445                 nodes[0].node.send_payment(route, our_payment_hash).unwrap();
7446                 check_added_monitors!(nodes[0], 1);
7447
7448                 let send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7449                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
7450
7451                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7452                 if let msgs::HandleError { err, action: Some(msgs::ErrorAction::IgnoreError) } = nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &send_event.commitment_msg).unwrap_err() {
7453                         assert_eq!(err, "Failed to update ChannelMonitor");
7454                 } else { panic!(); }
7455                 check_added_monitors!(nodes[1], 1);
7456                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7457
7458                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
7459                 nodes[1].node.test_restore_channel_monitor();
7460                 check_added_monitors!(nodes[1], 1);
7461                 let responses = nodes[1].node.get_and_clear_pending_msg_events();
7462                 assert_eq!(responses.len(), 2);
7463
7464                 match responses[0] {
7465                         MessageSendEvent::SendRevokeAndACK { ref msg, ref node_id } => {
7466                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7467                                 nodes[0].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &msg).unwrap();
7468                                 check_added_monitors!(nodes[0], 1);
7469                         },
7470                         _ => panic!("Unexpected event"),
7471                 }
7472                 match responses[1] {
7473                         MessageSendEvent::UpdateHTLCs { ref updates, ref node_id } => {
7474                                 assert!(updates.update_add_htlcs.is_empty());
7475                                 assert!(updates.update_fulfill_htlcs.is_empty());
7476                                 assert!(updates.update_fail_htlcs.is_empty());
7477                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
7478                                 assert!(updates.update_fee.is_none());
7479                                 assert_eq!(*node_id, nodes[0].node.get_our_node_id());
7480
7481                                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7482                                 if let msgs::HandleError { err, action: Some(msgs::ErrorAction::IgnoreError) } = nodes[0].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &updates.commitment_signed).unwrap_err() {
7483                                         assert_eq!(err, "Failed to update ChannelMonitor");
7484                                 } else { panic!(); }
7485                                 check_added_monitors!(nodes[0], 1);
7486                                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
7487                         },
7488                         _ => panic!("Unexpected event"),
7489                 }
7490
7491                 *nodes[0].chan_monitor.update_ret.lock().unwrap() = Ok(());
7492                 nodes[0].node.test_restore_channel_monitor();
7493                 check_added_monitors!(nodes[0], 1);
7494
7495                 let final_raa = get_event_msg!(nodes[0], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7496                 nodes[1].node.handle_revoke_and_ack(&nodes[0].node.get_our_node_id(), &final_raa).unwrap();
7497                 check_added_monitors!(nodes[1], 1);
7498
7499                 let mut events = nodes[1].node.get_and_clear_pending_events();
7500                 assert_eq!(events.len(), 1);
7501                 match events[0] {
7502                         Event::PendingHTLCsForwardable { .. } => { },
7503                         _ => panic!("Unexpected event"),
7504                 };
7505                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
7506                 nodes[1].node.process_pending_htlc_forwards();
7507
7508                 events = nodes[1].node.get_and_clear_pending_events();
7509                 assert_eq!(events.len(), 1);
7510                 match events[0] {
7511                         Event::PaymentReceived { payment_hash, amt } => {
7512                                 assert_eq!(payment_hash, our_payment_hash);
7513                                 assert_eq!(amt, 1000000);
7514                         },
7515                         _ => panic!("Unexpected event"),
7516                 };
7517
7518                 claim_payment(&nodes[0], &[&nodes[1]], payment_preimage);
7519         }
7520
7521         fn do_test_monitor_update_fail_raa(test_ignore_second_cs: bool) {
7522                 // Tests handling of a monitor update failure when processing an incoming RAA
7523                 let mut nodes = create_network(3);
7524                 create_announced_chan_between_nodes(&nodes, 0, 1);
7525                 create_announced_chan_between_nodes(&nodes, 1, 2);
7526
7527                 // Rebalance a bit so that we can send backwards from 2 to 1.
7528                 send_payment(&nodes[0], &[&nodes[1], &nodes[2]], 5000000);
7529
7530                 // Route a first payment that we'll fail backwards
7531                 let (_, payment_hash_1) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
7532
7533                 // Fail the payment backwards, failing the monitor update on nodes[1]'s receipt of the RAA
7534                 assert!(nodes[2].node.fail_htlc_backwards(&payment_hash_1, PaymentFailReason::PreimageUnknown));
7535                 check_added_monitors!(nodes[2], 1);
7536
7537                 let updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
7538                 assert!(updates.update_add_htlcs.is_empty());
7539                 assert!(updates.update_fulfill_htlcs.is_empty());
7540                 assert_eq!(updates.update_fail_htlcs.len(), 1);
7541                 assert!(updates.update_fail_malformed_htlcs.is_empty());
7542                 assert!(updates.update_fee.is_none());
7543                 nodes[1].node.handle_update_fail_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
7544
7545                 let bs_revoke_and_ack = commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false, true, false, true);
7546                 check_added_monitors!(nodes[0], 0);
7547
7548                 // While the second channel is AwaitingRAA, forward a second payment to get it into the
7549                 // holding cell.
7550                 let (payment_preimage_2, payment_hash_2) = get_payment_preimage_hash!(nodes[0]);
7551                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7552                 nodes[0].node.send_payment(route, payment_hash_2).unwrap();
7553                 check_added_monitors!(nodes[0], 1);
7554
7555                 let mut send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7556                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
7557                 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false);
7558
7559                 let events_1 = nodes[1].node.get_and_clear_pending_events();
7560                 assert_eq!(events_1.len(), 1);
7561                 match events_1[0] {
7562                         Event::PendingHTLCsForwardable { .. } => { },
7563                         _ => panic!("Unexpected event"),
7564                 };
7565
7566                 nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
7567                 nodes[1].node.process_pending_htlc_forwards();
7568                 check_added_monitors!(nodes[1], 0);
7569                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7570
7571                 // Now fail monitor updating.
7572                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7573                 if let msgs::HandleError { err, action: Some(msgs::ErrorAction::IgnoreError) } = nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap_err() {
7574                         assert_eq!(err, "Failed to update ChannelMonitor");
7575                 } else { panic!(); }
7576                 assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
7577                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7578                 check_added_monitors!(nodes[1], 1);
7579
7580                 // Attempt to forward a third payment but fail due to the second channel being unavailable
7581                 // for forwarding.
7582
7583                 let (_, payment_hash_3) = get_payment_preimage_hash!(nodes[0]);
7584                 let route = nodes[0].router.get_route(&nodes[2].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7585                 nodes[0].node.send_payment(route, payment_hash_3).unwrap();
7586                 check_added_monitors!(nodes[0], 1);
7587
7588                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(()); // We succeed in updating the monitor for the first channel
7589                 send_event = SendEvent::from_event(nodes[0].node.get_and_clear_pending_msg_events().remove(0));
7590                 nodes[1].node.handle_update_add_htlc(&nodes[0].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
7591                 commitment_signed_dance!(nodes[1], nodes[0], send_event.commitment_msg, false, true);
7592                 check_added_monitors!(nodes[1], 0);
7593
7594                 let mut events_2 = nodes[1].node.get_and_clear_pending_msg_events();
7595                 assert_eq!(events_2.len(), 1);
7596                 match events_2.remove(0) {
7597                         MessageSendEvent::UpdateHTLCs { node_id, updates } => {
7598                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7599                                 assert!(updates.update_fulfill_htlcs.is_empty());
7600                                 assert_eq!(updates.update_fail_htlcs.len(), 1);
7601                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
7602                                 assert!(updates.update_add_htlcs.is_empty());
7603                                 assert!(updates.update_fee.is_none());
7604
7605                                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fail_htlcs[0]).unwrap();
7606                                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
7607
7608                                 let events = nodes[0].node.get_and_clear_pending_events();
7609                                 assert_eq!(events.len(), 1);
7610                                 if let Event::PaymentFailed { payment_hash, rejected_by_dest } = events[0] {
7611                                         assert_eq!(payment_hash, payment_hash_3);
7612                                         assert!(!rejected_by_dest);
7613                                 } else { panic!("Unexpected event!"); }
7614                         },
7615                         _ => panic!("Unexpected event type!"),
7616                 };
7617
7618                 let (payment_preimage_4, payment_hash_4) = if test_ignore_second_cs {
7619                         // Try to route another payment backwards from 2 to make sure 1 holds off on responding
7620                         let (payment_preimage_4, payment_hash_4) = get_payment_preimage_hash!(nodes[0]);
7621                         let route = nodes[2].router.get_route(&nodes[0].node.get_our_node_id(), None, &Vec::new(), 1000000, TEST_FINAL_CLTV).unwrap();
7622                         nodes[2].node.send_payment(route, payment_hash_4).unwrap();
7623                         check_added_monitors!(nodes[2], 1);
7624
7625                         send_event = SendEvent::from_event(nodes[2].node.get_and_clear_pending_msg_events().remove(0));
7626                         nodes[1].node.handle_update_add_htlc(&nodes[2].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
7627                         if let Err(msgs::HandleError{err, action: Some(msgs::ErrorAction::IgnoreError) }) = nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &send_event.commitment_msg) {
7628                                 assert_eq!(err, "Previous monitor update failure prevented generation of RAA");
7629                         } else { panic!(); }
7630                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7631                         assert!(nodes[1].node.get_and_clear_pending_events().is_empty());
7632                         (Some(payment_preimage_4), Some(payment_hash_4))
7633                 } else { (None, None) };
7634
7635                 // Restore monitor updating, ensuring we immediately get a fail-back update and a
7636                 // update_add update.
7637                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
7638                 nodes[1].node.test_restore_channel_monitor();
7639                 check_added_monitors!(nodes[1], 2);
7640
7641                 let mut events_3 = nodes[1].node.get_and_clear_pending_msg_events();
7642                 if test_ignore_second_cs {
7643                         assert_eq!(events_3.len(), 3);
7644                 } else {
7645                         assert_eq!(events_3.len(), 2);
7646                 }
7647
7648                 // Note that the ordering of the events for different nodes is non-prescriptive, though the
7649                 // ordering of the two events that both go to nodes[2] have to stay in the same order.
7650                 let messages_a = match events_3.pop().unwrap() {
7651                         MessageSendEvent::UpdateHTLCs { node_id, mut updates } => {
7652                                 assert_eq!(node_id, nodes[0].node.get_our_node_id());
7653                                 assert!(updates.update_fulfill_htlcs.is_empty());
7654                                 assert_eq!(updates.update_fail_htlcs.len(), 1);
7655                                 assert!(updates.update_fail_malformed_htlcs.is_empty());
7656                                 assert!(updates.update_add_htlcs.is_empty());
7657                                 assert!(updates.update_fee.is_none());
7658                                 (updates.update_fail_htlcs.remove(0), updates.commitment_signed)
7659                         },
7660                         _ => panic!("Unexpected event type!"),
7661                 };
7662                 let raa = if test_ignore_second_cs {
7663                         match events_3.remove(1) {
7664                                 MessageSendEvent::SendRevokeAndACK { node_id, msg } => {
7665                                         assert_eq!(node_id, nodes[2].node.get_our_node_id());
7666                                         Some(msg.clone())
7667                                 },
7668                                 _ => panic!("Unexpected event"),
7669                         }
7670                 } else { None };
7671                 let send_event_b = SendEvent::from_event(events_3.remove(0));
7672                 assert_eq!(send_event_b.node_id, nodes[2].node.get_our_node_id());
7673
7674                 // Now deliver the new messages...
7675
7676                 nodes[0].node.handle_update_fail_htlc(&nodes[1].node.get_our_node_id(), &messages_a.0).unwrap();
7677                 commitment_signed_dance!(nodes[0], nodes[1], messages_a.1, false);
7678                 let events_4 = nodes[0].node.get_and_clear_pending_events();
7679                 assert_eq!(events_4.len(), 1);
7680                 if let Event::PaymentFailed { payment_hash, rejected_by_dest } = events_4[0] {
7681                         assert_eq!(payment_hash, payment_hash_1);
7682                         assert!(rejected_by_dest);
7683                 } else { panic!("Unexpected event!"); }
7684
7685                 nodes[2].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event_b.msgs[0]).unwrap();
7686                 if test_ignore_second_cs {
7687                         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &send_event_b.commitment_msg).unwrap();
7688                         check_added_monitors!(nodes[2], 1);
7689                         let bs_revoke_and_ack = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7690                         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &raa.unwrap()).unwrap();
7691                         check_added_monitors!(nodes[2], 1);
7692                         let bs_cs = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
7693                         assert!(bs_cs.update_add_htlcs.is_empty());
7694                         assert!(bs_cs.update_fail_htlcs.is_empty());
7695                         assert!(bs_cs.update_fail_malformed_htlcs.is_empty());
7696                         assert!(bs_cs.update_fulfill_htlcs.is_empty());
7697                         assert!(bs_cs.update_fee.is_none());
7698
7699                         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_revoke_and_ack).unwrap();
7700                         check_added_monitors!(nodes[1], 1);
7701                         let as_cs = get_htlc_update_msgs!(nodes[1], nodes[2].node.get_our_node_id());
7702                         assert!(as_cs.update_add_htlcs.is_empty());
7703                         assert!(as_cs.update_fail_htlcs.is_empty());
7704                         assert!(as_cs.update_fail_malformed_htlcs.is_empty());
7705                         assert!(as_cs.update_fulfill_htlcs.is_empty());
7706                         assert!(as_cs.update_fee.is_none());
7707
7708                         nodes[1].node.handle_commitment_signed(&nodes[2].node.get_our_node_id(), &bs_cs.commitment_signed).unwrap();
7709                         check_added_monitors!(nodes[1], 1);
7710                         let as_raa = get_event_msg!(nodes[1], MessageSendEvent::SendRevokeAndACK, nodes[2].node.get_our_node_id());
7711
7712                         nodes[2].node.handle_commitment_signed(&nodes[1].node.get_our_node_id(), &as_cs.commitment_signed).unwrap();
7713                         check_added_monitors!(nodes[2], 1);
7714                         let bs_second_raa = get_event_msg!(nodes[2], MessageSendEvent::SendRevokeAndACK, nodes[1].node.get_our_node_id());
7715
7716                         nodes[2].node.handle_revoke_and_ack(&nodes[1].node.get_our_node_id(), &as_raa).unwrap();
7717                         check_added_monitors!(nodes[2], 1);
7718                         assert!(nodes[2].node.get_and_clear_pending_msg_events().is_empty());
7719
7720                         nodes[1].node.handle_revoke_and_ack(&nodes[2].node.get_our_node_id(), &bs_second_raa).unwrap();
7721                         check_added_monitors!(nodes[1], 1);
7722                         assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7723                 } else {
7724                         commitment_signed_dance!(nodes[2], nodes[1], send_event_b.commitment_msg, false);
7725                 }
7726
7727                 let events_5 = nodes[2].node.get_and_clear_pending_events();
7728                 assert_eq!(events_5.len(), 1);
7729                 match events_5[0] {
7730                         Event::PendingHTLCsForwardable { .. } => { },
7731                         _ => panic!("Unexpected event"),
7732                 };
7733
7734                 nodes[2].node.channel_state.lock().unwrap().next_forward = Instant::now();
7735                 nodes[2].node.process_pending_htlc_forwards();
7736
7737                 let events_6 = nodes[2].node.get_and_clear_pending_events();
7738                 assert_eq!(events_6.len(), 1);
7739                 match events_6[0] {
7740                         Event::PaymentReceived { payment_hash, .. } => { assert_eq!(payment_hash, payment_hash_2); },
7741                         _ => panic!("Unexpected event"),
7742                 };
7743
7744                 if test_ignore_second_cs {
7745                         let events_7 = nodes[1].node.get_and_clear_pending_events();
7746                         assert_eq!(events_7.len(), 1);
7747                         match events_7[0] {
7748                                 Event::PendingHTLCsForwardable { .. } => { },
7749                                 _ => panic!("Unexpected event"),
7750                         };
7751
7752                         nodes[1].node.channel_state.lock().unwrap().next_forward = Instant::now();
7753                         nodes[1].node.process_pending_htlc_forwards();
7754                         check_added_monitors!(nodes[1], 1);
7755
7756                         send_event = SendEvent::from_node(&nodes[1]);
7757                         assert_eq!(send_event.node_id, nodes[0].node.get_our_node_id());
7758                         assert_eq!(send_event.msgs.len(), 1);
7759                         nodes[0].node.handle_update_add_htlc(&nodes[1].node.get_our_node_id(), &send_event.msgs[0]).unwrap();
7760                         commitment_signed_dance!(nodes[0], nodes[1], send_event.commitment_msg, false);
7761
7762                         let events_8 = nodes[0].node.get_and_clear_pending_events();
7763                         assert_eq!(events_8.len(), 1);
7764                         match events_8[0] {
7765                                 Event::PendingHTLCsForwardable { .. } => { },
7766                                 _ => panic!("Unexpected event"),
7767                         };
7768
7769                         nodes[0].node.channel_state.lock().unwrap().next_forward = Instant::now();
7770                         nodes[0].node.process_pending_htlc_forwards();
7771
7772                         let events_9 = nodes[0].node.get_and_clear_pending_events();
7773                         assert_eq!(events_9.len(), 1);
7774                         match events_9[0] {
7775                                 Event::PaymentReceived { payment_hash, .. } => assert_eq!(payment_hash, payment_hash_4.unwrap()),
7776                                 _ => panic!("Unexpected event"),
7777                         };
7778                         claim_payment(&nodes[2], &[&nodes[1], &nodes[0]], payment_preimage_4.unwrap());
7779                 }
7780
7781                 claim_payment(&nodes[0], &[&nodes[1], &nodes[2]], payment_preimage_2);
7782         }
7783
7784         #[test]
7785         fn test_monitor_update_fail_raa() {
7786                 do_test_monitor_update_fail_raa(false);
7787                 do_test_monitor_update_fail_raa(true);
7788         }
7789
7790         #[test]
7791         fn test_monitor_update_fail_reestablish() {
7792                 // Simple test for message retransmission after monitor update failure on
7793                 // channel_reestablish generating a monitor update (which comes from freeing holding cell
7794                 // HTLCs).
7795                 let mut nodes = create_network(3);
7796                 create_announced_chan_between_nodes(&nodes, 0, 1);
7797                 create_announced_chan_between_nodes(&nodes, 1, 2);
7798
7799                 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1], &nodes[2]], 1000000);
7800
7801                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7802                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7803
7804                 assert!(nodes[2].node.claim_funds(our_payment_preimage));
7805                 check_added_monitors!(nodes[2], 1);
7806                 let mut updates = get_htlc_update_msgs!(nodes[2], nodes[1].node.get_our_node_id());
7807                 assert!(updates.update_add_htlcs.is_empty());
7808                 assert!(updates.update_fail_htlcs.is_empty());
7809                 assert!(updates.update_fail_malformed_htlcs.is_empty());
7810                 assert!(updates.update_fee.is_none());
7811                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
7812                 nodes[1].node.handle_update_fulfill_htlc(&nodes[2].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
7813                 check_added_monitors!(nodes[1], 1);
7814                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7815                 commitment_signed_dance!(nodes[1], nodes[2], updates.commitment_signed, false);
7816
7817                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Err(ChannelMonitorUpdateErr::TemporaryFailure);
7818                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7819                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7820
7821                 let as_reestablish = get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id());
7822                 let bs_reestablish = get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
7823
7824                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish).unwrap();
7825
7826                 if let msgs::HandleError { err, action: Some(msgs::ErrorAction::IgnoreError) } = nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish).unwrap_err() {
7827                         assert_eq!(err, "Failed to update ChannelMonitor");
7828                 } else { panic!(); }
7829                 check_added_monitors!(nodes[1], 1);
7830
7831                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7832                 nodes[0].node.peer_disconnected(&nodes[1].node.get_our_node_id(), false);
7833
7834                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7835                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7836
7837                 assert!(as_reestablish == get_event_msg!(nodes[0], MessageSendEvent::SendChannelReestablish, nodes[1].node.get_our_node_id()));
7838                 assert!(bs_reestablish == get_event_msg!(nodes[1], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id()));
7839
7840                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &bs_reestablish).unwrap();
7841
7842                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &as_reestablish).unwrap();
7843                 check_added_monitors!(nodes[1], 0);
7844                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
7845
7846                 *nodes[1].chan_monitor.update_ret.lock().unwrap() = Ok(());
7847                 nodes[1].node.test_restore_channel_monitor();
7848                 check_added_monitors!(nodes[1], 1);
7849
7850                 updates = get_htlc_update_msgs!(nodes[1], nodes[0].node.get_our_node_id());
7851                 assert!(updates.update_add_htlcs.is_empty());
7852                 assert!(updates.update_fail_htlcs.is_empty());
7853                 assert!(updates.update_fail_malformed_htlcs.is_empty());
7854                 assert!(updates.update_fee.is_none());
7855                 assert_eq!(updates.update_fulfill_htlcs.len(), 1);
7856                 nodes[0].node.handle_update_fulfill_htlc(&nodes[1].node.get_our_node_id(), &updates.update_fulfill_htlcs[0]).unwrap();
7857                 commitment_signed_dance!(nodes[0], nodes[1], updates.commitment_signed, false);
7858
7859                 let events = nodes[0].node.get_and_clear_pending_events();
7860                 assert_eq!(events.len(), 1);
7861                 match events[0] {
7862                         Event::PaymentSent { payment_preimage, .. } => assert_eq!(payment_preimage, our_payment_preimage),
7863                         _ => panic!("Unexpected event"),
7864                 }
7865         }
7866
7867         #[test]
7868         fn test_invalid_channel_announcement() {
7869                 //Test BOLT 7 channel_announcement msg requirement for final node, gather data to build customed channel_announcement msgs
7870                 let secp_ctx = Secp256k1::new();
7871                 let nodes = create_network(2);
7872
7873                 let chan_announcement = create_chan_between_nodes(&nodes[0], &nodes[1]);
7874
7875                 let a_channel_lock = nodes[0].node.channel_state.lock().unwrap();
7876                 let b_channel_lock = nodes[1].node.channel_state.lock().unwrap();
7877                 let as_chan = a_channel_lock.by_id.get(&chan_announcement.3).unwrap();
7878                 let bs_chan = b_channel_lock.by_id.get(&chan_announcement.3).unwrap();
7879
7880                 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 } );
7881
7882                 let as_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &as_chan.get_local_keys().funding_key);
7883                 let bs_bitcoin_key = PublicKey::from_secret_key(&secp_ctx, &bs_chan.get_local_keys().funding_key);
7884
7885                 let as_network_key = nodes[0].node.get_our_node_id();
7886                 let bs_network_key = nodes[1].node.get_our_node_id();
7887
7888                 let were_node_one = as_bitcoin_key.serialize()[..] < bs_bitcoin_key.serialize()[..];
7889
7890                 let mut chan_announcement;
7891
7892                 macro_rules! dummy_unsigned_msg {
7893                         () => {
7894                                 msgs::UnsignedChannelAnnouncement {
7895                                         features: msgs::GlobalFeatures::new(),
7896                                         chain_hash: genesis_block(Network::Testnet).header.bitcoin_hash(),
7897                                         short_channel_id: as_chan.get_short_channel_id().unwrap(),
7898                                         node_id_1: if were_node_one { as_network_key } else { bs_network_key },
7899                                         node_id_2: if were_node_one { bs_network_key } else { as_network_key },
7900                                         bitcoin_key_1: if were_node_one { as_bitcoin_key } else { bs_bitcoin_key },
7901                                         bitcoin_key_2: if were_node_one { bs_bitcoin_key } else { as_bitcoin_key },
7902                                         excess_data: Vec::new(),
7903                                 };
7904                         }
7905                 }
7906
7907                 macro_rules! sign_msg {
7908                         ($unsigned_msg: expr) => {
7909                                 let msghash = Message::from_slice(&Sha256dHash::from_data(&$unsigned_msg.encode()[..])[..]).unwrap();
7910                                 let as_bitcoin_sig = secp_ctx.sign(&msghash, &as_chan.get_local_keys().funding_key);
7911                                 let bs_bitcoin_sig = secp_ctx.sign(&msghash, &bs_chan.get_local_keys().funding_key);
7912                                 let as_node_sig = secp_ctx.sign(&msghash, &nodes[0].node.our_network_key);
7913                                 let bs_node_sig = secp_ctx.sign(&msghash, &nodes[1].node.our_network_key);
7914                                 chan_announcement = msgs::ChannelAnnouncement {
7915                                         node_signature_1 : if were_node_one { as_node_sig } else { bs_node_sig},
7916                                         node_signature_2 : if were_node_one { bs_node_sig } else { as_node_sig},
7917                                         bitcoin_signature_1: if were_node_one { as_bitcoin_sig } else { bs_bitcoin_sig },
7918                                         bitcoin_signature_2 : if were_node_one { bs_bitcoin_sig } else { as_bitcoin_sig },
7919                                         contents: $unsigned_msg
7920                                 }
7921                         }
7922                 }
7923
7924                 let unsigned_msg = dummy_unsigned_msg!();
7925                 sign_msg!(unsigned_msg);
7926                 assert_eq!(nodes[0].router.handle_channel_announcement(&chan_announcement).unwrap(), true);
7927                 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 } );
7928
7929                 // Configured with Network::Testnet
7930                 let mut unsigned_msg = dummy_unsigned_msg!();
7931                 unsigned_msg.chain_hash = genesis_block(Network::Bitcoin).header.bitcoin_hash();
7932                 sign_msg!(unsigned_msg);
7933                 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
7934
7935                 let mut unsigned_msg = dummy_unsigned_msg!();
7936                 unsigned_msg.chain_hash = Sha256dHash::from_data(&[1,2,3,4,5,6,7,8,9]);
7937                 sign_msg!(unsigned_msg);
7938                 assert!(nodes[0].router.handle_channel_announcement(&chan_announcement).is_err());
7939         }
7940
7941         struct VecWriter(Vec<u8>);
7942         impl Writer for VecWriter {
7943                 fn write_all(&mut self, buf: &[u8]) -> Result<(), ::std::io::Error> {
7944                         self.0.extend_from_slice(buf);
7945                         Ok(())
7946                 }
7947                 fn size_hint(&mut self, size: usize) {
7948                         self.0.reserve_exact(size);
7949                 }
7950         }
7951
7952         #[test]
7953         fn test_no_txn_manager_serialize_deserialize() {
7954                 let mut nodes = create_network(2);
7955
7956                 let tx = create_chan_between_nodes_with_value_init(&nodes[0], &nodes[1], 100000, 10001);
7957
7958                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
7959
7960                 let nodes_0_serialized = nodes[0].node.encode();
7961                 let mut chan_0_monitor_serialized = VecWriter(Vec::new());
7962                 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
7963
7964                 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new())));
7965                 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
7966                 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
7967                 assert!(chan_0_monitor_read.is_empty());
7968
7969                 let mut nodes_0_read = &nodes_0_serialized[..];
7970                 let config = UserConfig::new();
7971                 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
7972                 let (_, nodes_0_deserialized) = {
7973                         let mut channel_monitors = HashMap::new();
7974                         channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
7975                         <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
7976                                 default_config: config,
7977                                 keys_manager,
7978                                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
7979                                 monitor: nodes[0].chan_monitor.clone(),
7980                                 chain_monitor: nodes[0].chain_monitor.clone(),
7981                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
7982                                 logger: Arc::new(test_utils::TestLogger::new()),
7983                                 channel_monitors: &channel_monitors,
7984                         }).unwrap()
7985                 };
7986                 assert!(nodes_0_read.is_empty());
7987
7988                 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
7989                 nodes[0].node = Arc::new(nodes_0_deserialized);
7990                 let nodes_0_as_listener: Arc<ChainListener> = nodes[0].node.clone();
7991                 nodes[0].chain_monitor.register_listener(Arc::downgrade(&nodes_0_as_listener));
7992                 assert_eq!(nodes[0].node.list_channels().len(), 1);
7993                 check_added_monitors!(nodes[0], 1);
7994
7995                 nodes[0].node.peer_connected(&nodes[1].node.get_our_node_id());
7996                 let reestablish_1 = get_chan_reestablish_msgs!(nodes[0], nodes[1]);
7997                 nodes[1].node.peer_connected(&nodes[0].node.get_our_node_id());
7998                 let reestablish_2 = get_chan_reestablish_msgs!(nodes[1], nodes[0]);
7999
8000                 nodes[1].node.handle_channel_reestablish(&nodes[0].node.get_our_node_id(), &reestablish_1[0]).unwrap();
8001                 assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
8002                 nodes[0].node.handle_channel_reestablish(&nodes[1].node.get_our_node_id(), &reestablish_2[0]).unwrap();
8003                 assert!(nodes[0].node.get_and_clear_pending_msg_events().is_empty());
8004
8005                 let (funding_locked, _) = create_chan_between_nodes_with_value_confirm(&nodes[0], &nodes[1], &tx);
8006                 let (announcement, as_update, bs_update) = create_chan_between_nodes_with_value_b(&nodes[0], &nodes[1], &funding_locked);
8007                 for node in nodes.iter() {
8008                         assert!(node.router.handle_channel_announcement(&announcement).unwrap());
8009                         node.router.handle_channel_update(&as_update).unwrap();
8010                         node.router.handle_channel_update(&bs_update).unwrap();
8011                 }
8012
8013                 send_payment(&nodes[0], &[&nodes[1]], 1000000);
8014         }
8015
8016         #[test]
8017         fn test_simple_manager_serialize_deserialize() {
8018                 let mut nodes = create_network(2);
8019                 create_announced_chan_between_nodes(&nodes, 0, 1);
8020
8021                 let (our_payment_preimage, _) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
8022                 let (_, our_payment_hash) = route_payment(&nodes[0], &[&nodes[1]], 1000000);
8023
8024                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8025
8026                 let nodes_0_serialized = nodes[0].node.encode();
8027                 let mut chan_0_monitor_serialized = VecWriter(Vec::new());
8028                 nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter().next().unwrap().1.write_for_disk(&mut chan_0_monitor_serialized).unwrap();
8029
8030                 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new())));
8031                 let mut chan_0_monitor_read = &chan_0_monitor_serialized.0[..];
8032                 let (_, chan_0_monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut chan_0_monitor_read, Arc::new(test_utils::TestLogger::new())).unwrap();
8033                 assert!(chan_0_monitor_read.is_empty());
8034
8035                 let mut nodes_0_read = &nodes_0_serialized[..];
8036                 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
8037                 let (_, nodes_0_deserialized) = {
8038                         let mut channel_monitors = HashMap::new();
8039                         channel_monitors.insert(chan_0_monitor.get_funding_txo().unwrap(), &chan_0_monitor);
8040                         <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
8041                                 default_config: UserConfig::new(),
8042                                 keys_manager,
8043                                 fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
8044                                 monitor: nodes[0].chan_monitor.clone(),
8045                                 chain_monitor: nodes[0].chain_monitor.clone(),
8046                                 tx_broadcaster: nodes[0].tx_broadcaster.clone(),
8047                                 logger: Arc::new(test_utils::TestLogger::new()),
8048                                 channel_monitors: &channel_monitors,
8049                         }).unwrap()
8050                 };
8051                 assert!(nodes_0_read.is_empty());
8052
8053                 assert!(nodes[0].chan_monitor.add_update_monitor(chan_0_monitor.get_funding_txo().unwrap(), chan_0_monitor).is_ok());
8054                 nodes[0].node = Arc::new(nodes_0_deserialized);
8055                 check_added_monitors!(nodes[0], 1);
8056
8057                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
8058
8059                 fail_payment(&nodes[0], &[&nodes[1]], our_payment_hash);
8060                 claim_payment(&nodes[0], &[&nodes[1]], our_payment_preimage);
8061         }
8062
8063         #[test]
8064         fn test_manager_serialize_deserialize_inconsistent_monitor() {
8065                 // Test deserializing a ChannelManager with a out-of-date ChannelMonitor
8066                 let mut nodes = create_network(4);
8067                 create_announced_chan_between_nodes(&nodes, 0, 1);
8068                 create_announced_chan_between_nodes(&nodes, 2, 0);
8069                 let (_, _, channel_id, funding_tx) = create_announced_chan_between_nodes(&nodes, 0, 3);
8070
8071                 let (our_payment_preimage, _) = route_payment(&nodes[2], &[&nodes[0], &nodes[1]], 1000000);
8072
8073                 // Serialize the ChannelManager here, but the monitor we keep up-to-date
8074                 let nodes_0_serialized = nodes[0].node.encode();
8075
8076                 route_payment(&nodes[0], &[&nodes[3]], 1000000);
8077                 nodes[1].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8078                 nodes[2].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8079                 nodes[3].node.peer_disconnected(&nodes[0].node.get_our_node_id(), false);
8080
8081                 // Now the ChannelMonitor (which is now out-of-sync with ChannelManager for channel w/
8082                 // nodes[3])
8083                 let mut node_0_monitors_serialized = Vec::new();
8084                 for monitor in nodes[0].chan_monitor.simple_monitor.monitors.lock().unwrap().iter() {
8085                         let mut writer = VecWriter(Vec::new());
8086                         monitor.1.write_for_disk(&mut writer).unwrap();
8087                         node_0_monitors_serialized.push(writer.0);
8088                 }
8089
8090                 nodes[0].chan_monitor = Arc::new(test_utils::TestChannelMonitor::new(nodes[0].chain_monitor.clone(), nodes[0].tx_broadcaster.clone(), Arc::new(test_utils::TestLogger::new())));
8091                 let mut node_0_monitors = Vec::new();
8092                 for serialized in node_0_monitors_serialized.iter() {
8093                         let mut read = &serialized[..];
8094                         let (_, monitor) = <(Sha256dHash, ChannelMonitor)>::read(&mut read, Arc::new(test_utils::TestLogger::new())).unwrap();
8095                         assert!(read.is_empty());
8096                         node_0_monitors.push(monitor);
8097                 }
8098
8099                 let mut nodes_0_read = &nodes_0_serialized[..];
8100                 let keys_manager = Arc::new(keysinterface::KeysManager::new(&nodes[0].node_seed, Network::Testnet, Arc::new(test_utils::TestLogger::new())));
8101                 let (_, nodes_0_deserialized) = <(Sha256dHash, ChannelManager)>::read(&mut nodes_0_read, ChannelManagerReadArgs {
8102                         default_config: UserConfig::new(),
8103                         keys_manager,
8104                         fee_estimator: Arc::new(test_utils::TestFeeEstimator { sat_per_kw: 253 }),
8105                         monitor: nodes[0].chan_monitor.clone(),
8106                         chain_monitor: nodes[0].chain_monitor.clone(),
8107                         tx_broadcaster: nodes[0].tx_broadcaster.clone(),
8108                         logger: Arc::new(test_utils::TestLogger::new()),
8109                         channel_monitors: &node_0_monitors.iter().map(|monitor| { (monitor.get_funding_txo().unwrap(), monitor) }).collect(),
8110                 }).unwrap();
8111                 assert!(nodes_0_read.is_empty());
8112
8113                 { // Channel close should result in a commitment tx and an HTLC tx
8114                         let txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8115                         assert_eq!(txn.len(), 2);
8116                         assert_eq!(txn[0].input[0].previous_output.txid, funding_tx.txid());
8117                         assert_eq!(txn[1].input[0].previous_output.txid, txn[0].txid());
8118                 }
8119
8120                 for monitor in node_0_monitors.drain(..) {
8121                         assert!(nodes[0].chan_monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor).is_ok());
8122                         check_added_monitors!(nodes[0], 1);
8123                 }
8124                 nodes[0].node = Arc::new(nodes_0_deserialized);
8125
8126                 // nodes[1] and nodes[2] have no lost state with nodes[0]...
8127                 reconnect_nodes(&nodes[0], &nodes[1], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
8128                 reconnect_nodes(&nodes[0], &nodes[2], (false, false), (0, 0), (0, 0), (0, 0), (0, 0), (false, false));
8129                 //... and we can even still claim the payment!
8130                 claim_payment(&nodes[2], &[&nodes[0], &nodes[1]], our_payment_preimage);
8131
8132                 nodes[3].node.peer_connected(&nodes[0].node.get_our_node_id());
8133                 let reestablish = get_event_msg!(nodes[3], MessageSendEvent::SendChannelReestablish, nodes[0].node.get_our_node_id());
8134                 nodes[0].node.peer_connected(&nodes[3].node.get_our_node_id());
8135                 if let Err(msgs::HandleError { action: Some(msgs::ErrorAction::SendErrorMessage { msg }), .. }) = nodes[0].node.handle_channel_reestablish(&nodes[3].node.get_our_node_id(), &reestablish) {
8136                         assert_eq!(msg.channel_id, channel_id);
8137                 } else { panic!("Unexpected result"); }
8138         }
8139
8140         macro_rules! check_spendable_outputs {
8141                 ($node: expr, $der_idx: expr) => {
8142                         {
8143                                 let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
8144                                 let mut txn = Vec::new();
8145                                 for event in events {
8146                                         match event {
8147                                                 Event::SpendableOutputs { ref outputs } => {
8148                                                         for outp in outputs {
8149                                                                 match *outp {
8150                                                                         SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
8151                                                                                 let input = TxIn {
8152                                                                                         previous_output: outpoint.clone(),
8153                                                                                         script_sig: Script::new(),
8154                                                                                         sequence: 0,
8155                                                                                         witness: Vec::new(),
8156                                                                                 };
8157                                                                                 let outp = TxOut {
8158                                                                                         script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
8159                                                                                         value: output.value,
8160                                                                                 };
8161                                                                                 let mut spend_tx = Transaction {
8162                                                                                         version: 2,
8163                                                                                         lock_time: 0,
8164                                                                                         input: vec![input],
8165                                                                                         output: vec![outp],
8166                                                                                 };
8167                                                                                 let secp_ctx = Secp256k1::new();
8168                                                                                 let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
8169                                                                                 let witness_script = Address::p2pkh(&remotepubkey, Network::Testnet).script_pubkey();
8170                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
8171                                                                                 let remotesig = secp_ctx.sign(&sighash, key);
8172                                                                                 spend_tx.input[0].witness.push(remotesig.serialize_der(&secp_ctx).to_vec());
8173                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
8174                                                                                 spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
8175                                                                                 txn.push(spend_tx);
8176                                                                         },
8177                                                                         SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
8178                                                                                 let input = TxIn {
8179                                                                                         previous_output: outpoint.clone(),
8180                                                                                         script_sig: Script::new(),
8181                                                                                         sequence: *to_self_delay as u32,
8182                                                                                         witness: Vec::new(),
8183                                                                                 };
8184                                                                                 let outp = TxOut {
8185                                                                                         script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
8186                                                                                         value: output.value,
8187                                                                                 };
8188                                                                                 let mut spend_tx = Transaction {
8189                                                                                         version: 2,
8190                                                                                         lock_time: 0,
8191                                                                                         input: vec![input],
8192                                                                                         output: vec![outp],
8193                                                                                 };
8194                                                                                 let secp_ctx = Secp256k1::new();
8195                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], witness_script, output.value)[..]).unwrap();
8196                                                                                 let local_delaysig = secp_ctx.sign(&sighash, key);
8197                                                                                 spend_tx.input[0].witness.push(local_delaysig.serialize_der(&secp_ctx).to_vec());
8198                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
8199                                                                                 spend_tx.input[0].witness.push(vec!(0));
8200                                                                                 spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
8201                                                                                 txn.push(spend_tx);
8202                                                                         },
8203                                                                         SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
8204                                                                                 let secp_ctx = Secp256k1::new();
8205                                                                                 let input = TxIn {
8206                                                                                         previous_output: outpoint.clone(),
8207                                                                                         script_sig: Script::new(),
8208                                                                                         sequence: 0,
8209                                                                                         witness: Vec::new(),
8210                                                                                 };
8211                                                                                 let outp = TxOut {
8212                                                                                         script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
8213                                                                                         value: output.value,
8214                                                                                 };
8215                                                                                 let mut spend_tx = Transaction {
8216                                                                                         version: 2,
8217                                                                                         lock_time: 0,
8218                                                                                         input: vec![input],
8219                                                                                         output: vec![outp.clone()],
8220                                                                                 };
8221                                                                                 let secret = {
8222                                                                                         match ExtendedPrivKey::new_master(&secp_ctx, Network::Testnet, &$node.node_seed) {
8223                                                                                                 Ok(master_key) => {
8224                                                                                                         match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx)) {
8225                                                                                                                 Ok(key) => key,
8226                                                                                                                 Err(_) => panic!("Your RNG is busted"),
8227                                                                                                         }
8228                                                                                                 }
8229                                                                                                 Err(_) => panic!("Your rng is busted"),
8230                                                                                         }
8231                                                                                 };
8232                                                                                 let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
8233                                                                                 let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
8234                                                                                 let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
8235                                                                                 let sig = secp_ctx.sign(&sighash, &secret.secret_key);
8236                                                                                 spend_tx.input[0].witness.push(sig.serialize_der(&secp_ctx).to_vec());
8237                                                                                 spend_tx.input[0].witness[0].push(SigHashType::All as u8);
8238                                                                                 spend_tx.input[0].witness.push(pubkey.serialize().to_vec());
8239                                                                                 txn.push(spend_tx);
8240                                                                         },
8241                                                                 }
8242                                                         }
8243                                                 },
8244                                                 _ => panic!("Unexpected event"),
8245                                         };
8246                                 }
8247                                 txn
8248                         }
8249                 }
8250         }
8251
8252         #[test]
8253         fn test_claim_sizeable_push_msat() {
8254                 // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
8255                 let nodes = create_network(2);
8256
8257                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
8258                 nodes[1].node.force_close_channel(&chan.2);
8259                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8260                 match events[0] {
8261                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8262                         _ => panic!("Unexpected event"),
8263                 }
8264                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8265                 assert_eq!(node_txn.len(), 1);
8266                 check_spends!(node_txn[0], chan.3.clone());
8267                 assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
8268
8269                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8270                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
8271                 let spend_txn = check_spendable_outputs!(nodes[1], 1);
8272                 assert_eq!(spend_txn.len(), 1);
8273                 check_spends!(spend_txn[0], node_txn[0].clone());
8274         }
8275
8276         #[test]
8277         fn test_claim_on_remote_sizeable_push_msat() {
8278                 // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
8279                 // to_remote output is encumbered by a P2WPKH
8280
8281                 let nodes = create_network(2);
8282
8283                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 99000000);
8284                 nodes[0].node.force_close_channel(&chan.2);
8285                 let events = nodes[0].node.get_and_clear_pending_msg_events();
8286                 match events[0] {
8287                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8288                         _ => panic!("Unexpected event"),
8289                 }
8290                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8291                 assert_eq!(node_txn.len(), 1);
8292                 check_spends!(node_txn[0], chan.3.clone());
8293                 assert_eq!(node_txn[0].output.len(), 2); // We can't force trimming of to_remote output as channel_reserve_satoshis block us to do so at channel opening
8294
8295                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8296                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
8297                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8298                 match events[0] {
8299                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8300                         _ => panic!("Unexpected event"),
8301                 }
8302                 let spend_txn = check_spendable_outputs!(nodes[1], 1);
8303                 assert_eq!(spend_txn.len(), 2);
8304                 assert_eq!(spend_txn[0], spend_txn[1]);
8305                 check_spends!(spend_txn[0], node_txn[0].clone());
8306         }
8307
8308         #[test]
8309         fn test_claim_on_remote_revoked_sizeable_push_msat() {
8310                 // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
8311                 // to_remote output is encumbered by a P2WPKH
8312
8313                 let nodes = create_network(2);
8314
8315                 let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000);
8316                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8317                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
8318                 assert_eq!(revoked_local_txn[0].input.len(), 1);
8319                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
8320
8321                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8322                 let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8323                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
8324                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8325                 match events[0] {
8326                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8327                         _ => panic!("Unexpected event"),
8328                 }
8329                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8330                 let spend_txn = check_spendable_outputs!(nodes[1], 1);
8331                 assert_eq!(spend_txn.len(), 4);
8332                 assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
8333                 check_spends!(spend_txn[0], revoked_local_txn[0].clone());
8334                 assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
8335                 check_spends!(spend_txn[1], node_txn[0].clone());
8336         }
8337
8338         #[test]
8339         fn test_static_spendable_outputs_preimage_tx() {
8340                 let nodes = create_network(2);
8341
8342                 // Create some initial channels
8343                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8344
8345                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8346
8347                 let commitment_tx = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
8348                 assert_eq!(commitment_tx[0].input.len(), 1);
8349                 assert_eq!(commitment_tx[0].input[0].previous_output.txid, chan_1.3.txid());
8350
8351                 // Settle A's commitment tx on B's chain
8352                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8353                 assert!(nodes[1].node.claim_funds(payment_preimage));
8354                 check_added_monitors!(nodes[1], 1);
8355                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![commitment_tx[0].clone()] }, 1);
8356                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8357                 match events[0] {
8358                         MessageSendEvent::UpdateHTLCs { .. } => {},
8359                         _ => panic!("Unexpected event"),
8360                 }
8361                 match events[1] {
8362                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8363                         _ => panic!("Unexepected event"),
8364                 }
8365
8366                 // Check B's monitor was able to send back output descriptor event for preimage tx on A's commitment tx
8367                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap(); // ChannelManager : 1 (local commitment tx), ChannelMonitor: 2 (1 preimage tx) * 2 (block-rescan)
8368                 check_spends!(node_txn[0], commitment_tx[0].clone());
8369                 assert_eq!(node_txn[0], node_txn[2]);
8370                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 133);
8371                 check_spends!(node_txn[1], chan_1.3.clone());
8372
8373                 let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
8374                 assert_eq!(spend_txn.len(), 2);
8375                 assert_eq!(spend_txn[0], spend_txn[1]);
8376                 check_spends!(spend_txn[0], node_txn[0].clone());
8377         }
8378
8379         #[test]
8380         fn test_static_spendable_outputs_justice_tx_revoked_commitment_tx() {
8381                 let nodes = create_network(2);
8382
8383                 // Create some initial channels
8384                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8385
8386                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8387                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.iter().next().unwrap().1.last_local_commitment_txn.clone();
8388                 assert_eq!(revoked_local_txn[0].input.len(), 1);
8389                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
8390
8391                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8392
8393                 let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8394                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
8395                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8396                 match events[0] {
8397                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8398                         _ => panic!("Unexpected event"),
8399                 }
8400                 let mut node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8401                 assert_eq!(node_txn.len(), 3);
8402                 assert_eq!(node_txn.pop().unwrap(), node_txn[0]);
8403                 assert_eq!(node_txn[0].input.len(), 2);
8404                 check_spends!(node_txn[0], revoked_local_txn[0].clone());
8405
8406                 let spend_txn = check_spendable_outputs!(nodes[1], 1);
8407                 assert_eq!(spend_txn.len(), 2);
8408                 assert_eq!(spend_txn[0], spend_txn[1]);
8409                 check_spends!(spend_txn[0], node_txn[0].clone());
8410         }
8411
8412         #[test]
8413         fn test_static_spendable_outputs_justice_tx_revoked_htlc_timeout_tx() {
8414                 let nodes = create_network(2);
8415
8416                 // Create some initial channels
8417                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8418
8419                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8420                 let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
8421                 assert_eq!(revoked_local_txn[0].input.len(), 1);
8422                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
8423
8424                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8425
8426                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8427                 // A will generate HTLC-Timeout from revoked commitment tx
8428                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
8429                 let events = nodes[0].node.get_and_clear_pending_msg_events();
8430                 match events[0] {
8431                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8432                         _ => panic!("Unexpected event"),
8433                 }
8434                 let revoked_htlc_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8435                 assert_eq!(revoked_htlc_txn.len(), 3);
8436                 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
8437                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8438                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), 133);
8439                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
8440                 check_spends!(revoked_htlc_txn[1], chan_1.3.clone());
8441
8442                 // B will generate justice tx from A's revoked commitment/HTLC tx
8443                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
8444                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8445                 match events[0] {
8446                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8447                         _ => panic!("Unexpected event"),
8448                 }
8449
8450                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8451                 assert_eq!(node_txn.len(), 4);
8452                 assert_eq!(node_txn[3].input.len(), 1);
8453                 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
8454
8455                 // Check B's ChannelMonitor was able to generate the right spendable output descriptor
8456                 let spend_txn = check_spendable_outputs!(nodes[1], 1);
8457                 assert_eq!(spend_txn.len(), 3);
8458                 assert_eq!(spend_txn[0], spend_txn[1]);
8459                 check_spends!(spend_txn[0], node_txn[0].clone());
8460                 check_spends!(spend_txn[2], node_txn[3].clone());
8461         }
8462
8463         #[test]
8464         fn test_static_spendable_outputs_justice_tx_revoked_htlc_success_tx() {
8465                 let nodes = create_network(2);
8466
8467                 // Create some initial channels
8468                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8469
8470                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
8471                 let revoked_local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
8472                 assert_eq!(revoked_local_txn[0].input.len(), 1);
8473                 assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan_1.3.txid());
8474
8475                 claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
8476
8477                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8478                 // B will generate HTLC-Success from revoked commitment tx
8479                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
8480                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8481                 match events[0] {
8482                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8483                         _ => panic!("Unexpected event"),
8484                 }
8485                 let revoked_htlc_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8486
8487                 assert_eq!(revoked_htlc_txn.len(), 3);
8488                 assert_eq!(revoked_htlc_txn[0], revoked_htlc_txn[2]);
8489                 assert_eq!(revoked_htlc_txn[0].input.len(), 1);
8490                 assert_eq!(revoked_htlc_txn[0].input[0].witness.last().unwrap().len(), 138);
8491                 check_spends!(revoked_htlc_txn[0], revoked_local_txn[0].clone());
8492
8493                 // A will generate justice tx from B's revoked commitment/HTLC tx
8494                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone(), revoked_htlc_txn[0].clone()] }, 1);
8495                 let events = nodes[0].node.get_and_clear_pending_msg_events();
8496                 match events[0] {
8497                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8498                         _ => panic!("Unexpected event"),
8499                 }
8500
8501                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8502                 assert_eq!(node_txn.len(), 4);
8503                 assert_eq!(node_txn[3].input.len(), 1);
8504                 check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
8505
8506                 // Check A's ChannelMonitor was able to generate the right spendable output descriptor
8507                 let spend_txn = check_spendable_outputs!(nodes[0], 1);
8508                 assert_eq!(spend_txn.len(), 5);
8509                 assert_eq!(spend_txn[0], spend_txn[2]);
8510                 assert_eq!(spend_txn[1], spend_txn[3]);
8511                 check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
8512                 check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
8513                 check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
8514         }
8515
8516         #[test]
8517         fn test_dynamic_spendable_outputs_local_htlc_success_tx() {
8518                 let nodes = create_network(2);
8519
8520                 // Create some initial channels
8521                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8522
8523                 let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
8524                 let local_txn = nodes[1].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
8525                 assert_eq!(local_txn[0].input.len(), 1);
8526                 check_spends!(local_txn[0], chan_1.3.clone());
8527
8528                 // Give B knowledge of preimage to be able to generate a local HTLC-Success Tx
8529                 nodes[1].node.claim_funds(payment_preimage);
8530                 check_added_monitors!(nodes[1], 1);
8531                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8532                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 1);
8533                 let events = nodes[1].node.get_and_clear_pending_msg_events();
8534                 match events[0] {
8535                         MessageSendEvent::UpdateHTLCs { .. } => {},
8536                         _ => panic!("Unexpected event"),
8537                 }
8538                 match events[1] {
8539                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8540                         _ => panic!("Unexepected event"),
8541                 }
8542                 let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
8543                 assert_eq!(node_txn[0].input.len(), 1);
8544                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 138);
8545                 check_spends!(node_txn[0], local_txn[0].clone());
8546
8547                 // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
8548                 let spend_txn = check_spendable_outputs!(nodes[1], 1);
8549                 assert_eq!(spend_txn.len(), 2);
8550                 check_spends!(spend_txn[0], node_txn[0].clone());
8551                 check_spends!(spend_txn[1], node_txn[2].clone());
8552         }
8553
8554         #[test]
8555         fn test_dynamic_spendable_outputs_local_htlc_timeout_tx() {
8556                 let nodes = create_network(2);
8557
8558                 // Create some initial channels
8559                 let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
8560
8561                 route_payment(&nodes[0], &vec!(&nodes[1])[..], 9000000).0;
8562                 let local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().last_local_commitment_txn.clone();
8563                 assert_eq!(local_txn[0].input.len(), 1);
8564                 check_spends!(local_txn[0], chan_1.3.clone());
8565
8566                 // Timeout HTLC on A's chain and so it can generate a HTLC-Timeout tx
8567                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8568                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![local_txn[0].clone()] }, 200);
8569                 let events = nodes[0].node.get_and_clear_pending_msg_events();
8570                 match events[0] {
8571                         MessageSendEvent::BroadcastChannelUpdate { .. } => {},
8572                         _ => panic!("Unexepected event"),
8573                 }
8574                 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
8575                 assert_eq!(node_txn[0].input.len(), 1);
8576                 assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 133);
8577                 check_spends!(node_txn[0], local_txn[0].clone());
8578
8579                 // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
8580                 let spend_txn = check_spendable_outputs!(nodes[0], 1);
8581                 assert_eq!(spend_txn.len(), 8);
8582                 assert_eq!(spend_txn[0], spend_txn[2]);
8583                 assert_eq!(spend_txn[0], spend_txn[4]);
8584                 assert_eq!(spend_txn[0], spend_txn[6]);
8585                 assert_eq!(spend_txn[1], spend_txn[3]);
8586                 assert_eq!(spend_txn[1], spend_txn[5]);
8587                 assert_eq!(spend_txn[1], spend_txn[7]);
8588                 check_spends!(spend_txn[0], local_txn[0].clone());
8589                 check_spends!(spend_txn[1], node_txn[0].clone());
8590         }
8591
8592         #[test]
8593         fn test_static_output_closing_tx() {
8594                 let nodes = create_network(2);
8595
8596                 let chan = create_announced_chan_between_nodes(&nodes, 0, 1);
8597
8598                 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
8599                 let closing_tx = close_channel(&nodes[0], &nodes[1], &chan.2, chan.3, true).2;
8600
8601                 let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
8602                 nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
8603                 let spend_txn = check_spendable_outputs!(nodes[0], 2);
8604                 assert_eq!(spend_txn.len(), 1);
8605                 check_spends!(spend_txn[0], closing_tx.clone());
8606
8607                 nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
8608                 let spend_txn = check_spendable_outputs!(nodes[1], 2);
8609                 assert_eq!(spend_txn.len(), 1);
8610                 check_spends!(spend_txn[0], closing_tx);
8611         }
8612 }