b73f8667073bac64abdb11fd9e2f7e81fbb07c7e
[rust-lightning] / 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;
16
17 use bitcoin_hashes::{Hash, HashEngine};
18 use bitcoin_hashes::hmac::{Hmac, HmacEngine};
19 use bitcoin_hashes::sha256::Hash as Sha256;
20 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
21 use bitcoin_hashes::cmp::fixed_time_eq;
22
23 use secp256k1::key::{SecretKey,PublicKey};
24 use secp256k1::Secp256k1;
25 use secp256k1::ecdh::SharedSecret;
26 use secp256k1;
27
28 use chain::chaininterface::{BroadcasterInterface,ChainListener,FeeEstimator};
29 use chain::transaction::OutPoint;
30 use ln::channel::{Channel, ChannelError};
31 use ln::channelmonitor::{ChannelMonitor, ChannelMonitorUpdateErr, ManyChannelMonitor, CLTV_CLAIM_BUFFER, LATENCY_GRACE_PERIOD_BLOCKS, ANTI_REORG_DELAY};
32 use ln::router::Route;
33 use ln::features::{InitFeatures, NodeFeatures};
34 use ln::msgs;
35 use ln::onion_utils;
36 use ln::msgs::{ChannelMessageHandler, DecodeError, LightningError};
37 use chain::keysinterface::{ChannelKeys, KeysInterface, InMemoryChannelKeys};
38 use util::config::UserConfig;
39 use util::{byte_utils, events};
40 use util::ser::{Readable, ReadableArgs, Writeable, Writer};
41 use util::chacha20::{ChaCha20, ChaChaReader};
42 use util::logger::Logger;
43 use util::errors::APIError;
44
45 use std::{cmp, mem};
46 use std::collections::{HashMap, hash_map, HashSet};
47 use std::io::{Cursor, Read};
48 use std::sync::{Arc, Mutex, MutexGuard, RwLock};
49 use std::sync::atomic::{AtomicUsize, Ordering};
50 use std::time::Duration;
51 use std::marker::{Sync, Send};
52 use std::ops::Deref;
53
54 // We hold various information about HTLC relay in the HTLC objects in Channel itself:
55 //
56 // Upon receipt of an HTLC from a peer, we'll give it a PendingHTLCStatus indicating if it should
57 // forward the HTLC with information it will give back to us when it does so, or if it should Fail
58 // the HTLC with the relevant message for the Channel to handle giving to the remote peer.
59 //
60 // Once said HTLC is committed in the Channel, if the PendingHTLCStatus indicated Forward, the
61 // Channel will return the PendingHTLCInfo back to us, and we will create an HTLCForwardInfo
62 // with it to track where it came from (in case of onwards-forward error), waiting a random delay
63 // before we forward it.
64 //
65 // We will then use HTLCForwardInfo's PendingHTLCInfo to construct an outbound HTLC, with a
66 // relevant HTLCSource::PreviousHopData filled in to indicate where it came from (which we can use
67 // to either fail-backwards or fulfill the HTLC backwards along the relevant path).
68 // Alternatively, we can fill an outbound HTLC with a HTLCSource::OutboundRoute indicating this is
69 // our payment, which we can use to decode errors or inform the user that the payment was sent.
70
71 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
72 pub(super) struct PendingHTLCInfo {
73         onion_packet: Option<msgs::OnionPacket>,
74         incoming_shared_secret: [u8; 32],
75         payment_hash: PaymentHash,
76         short_channel_id: u64,
77         pub(super) amt_to_forward: u64,
78         pub(super) outgoing_cltv_value: u32,
79 }
80
81 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
82 pub(super) enum HTLCFailureMsg {
83         Relay(msgs::UpdateFailHTLC),
84         Malformed(msgs::UpdateFailMalformedHTLC),
85 }
86
87 /// Stores whether we can't forward an HTLC or relevant forwarding info
88 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
89 pub(super) enum PendingHTLCStatus {
90         Forward(PendingHTLCInfo),
91         Fail(HTLCFailureMsg),
92 }
93
94 pub(super) enum HTLCForwardInfo {
95         AddHTLC {
96                 prev_short_channel_id: u64,
97                 prev_htlc_id: u64,
98                 forward_info: PendingHTLCInfo,
99         },
100         FailHTLC {
101                 htlc_id: u64,
102                 err_packet: msgs::OnionErrorPacket,
103         },
104 }
105
106 /// Tracks the inbound corresponding to an outbound HTLC
107 #[derive(Clone, PartialEq)]
108 pub(super) struct HTLCPreviousHopData {
109         short_channel_id: u64,
110         htlc_id: u64,
111         incoming_packet_shared_secret: [u8; 32],
112 }
113
114 /// Tracks the inbound corresponding to an outbound HTLC
115 #[derive(Clone, PartialEq)]
116 pub(super) enum HTLCSource {
117         PreviousHopData(HTLCPreviousHopData),
118         OutboundRoute {
119                 route: Route,
120                 session_priv: SecretKey,
121                 /// Technically we can recalculate this from the route, but we cache it here to avoid
122                 /// doing a double-pass on route when we get a failure back
123                 first_hop_htlc_msat: u64,
124         },
125 }
126 #[cfg(test)]
127 impl HTLCSource {
128         pub fn dummy() -> Self {
129                 HTLCSource::OutboundRoute {
130                         route: Route { hops: Vec::new() },
131                         session_priv: SecretKey::from_slice(&[1; 32]).unwrap(),
132                         first_hop_htlc_msat: 0,
133                 }
134         }
135 }
136
137 #[derive(Clone)] // See Channel::revoke_and_ack for why, tl;dr: Rust bug
138 pub(super) enum HTLCFailReason {
139         LightningError {
140                 err: msgs::OnionErrorPacket,
141         },
142         Reason {
143                 failure_code: u16,
144                 data: Vec<u8>,
145         }
146 }
147
148 /// payment_hash type, use to cross-lock hop
149 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
150 pub struct PaymentHash(pub [u8;32]);
151 /// payment_preimage type, use to route payment between hop
152 #[derive(Hash, Copy, Clone, PartialEq, Eq, Debug)]
153 pub struct PaymentPreimage(pub [u8;32]);
154
155 type ShutdownResult = (Vec<Transaction>, Vec<(HTLCSource, PaymentHash)>);
156
157 /// Error type returned across the channel_state mutex boundary. When an Err is generated for a
158 /// Channel, we generally end up with a ChannelError::Close for which we have to close the channel
159 /// immediately (ie with no further calls on it made). Thus, this step happens inside a
160 /// channel_state lock. We then return the set of things that need to be done outside the lock in
161 /// this struct and call handle_error!() on it.
162
163 struct MsgHandleErrInternal {
164         err: msgs::LightningError,
165         shutdown_finish: Option<(ShutdownResult, Option<msgs::ChannelUpdate>)>,
166 }
167 impl MsgHandleErrInternal {
168         #[inline]
169         fn send_err_msg_no_close(err: &'static str, channel_id: [u8; 32]) -> Self {
170                 Self {
171                         err: LightningError {
172                                 err,
173                                 action: msgs::ErrorAction::SendErrorMessage {
174                                         msg: msgs::ErrorMessage {
175                                                 channel_id,
176                                                 data: err.to_string()
177                                         },
178                                 },
179                         },
180                         shutdown_finish: None,
181                 }
182         }
183         #[inline]
184         fn ignore_no_close(err: &'static str) -> Self {
185                 Self {
186                         err: LightningError {
187                                 err,
188                                 action: msgs::ErrorAction::IgnoreError,
189                         },
190                         shutdown_finish: None,
191                 }
192         }
193         #[inline]
194         fn from_no_close(err: msgs::LightningError) -> Self {
195                 Self { err, shutdown_finish: None }
196         }
197         #[inline]
198         fn from_finish_shutdown(err: &'static str, channel_id: [u8; 32], shutdown_res: ShutdownResult, channel_update: Option<msgs::ChannelUpdate>) -> Self {
199                 Self {
200                         err: LightningError {
201                                 err,
202                                 action: msgs::ErrorAction::SendErrorMessage {
203                                         msg: msgs::ErrorMessage {
204                                                 channel_id,
205                                                 data: err.to_string()
206                                         },
207                                 },
208                         },
209                         shutdown_finish: Some((shutdown_res, channel_update)),
210                 }
211         }
212         #[inline]
213         fn from_chan_no_close(err: ChannelError, channel_id: [u8; 32]) -> Self {
214                 Self {
215                         err: match err {
216                                 ChannelError::Ignore(msg) => LightningError {
217                                         err: msg,
218                                         action: msgs::ErrorAction::IgnoreError,
219                                 },
220                                 ChannelError::Close(msg) => LightningError {
221                                         err: msg,
222                                         action: msgs::ErrorAction::SendErrorMessage {
223                                                 msg: msgs::ErrorMessage {
224                                                         channel_id,
225                                                         data: msg.to_string()
226                                                 },
227                                         },
228                                 },
229                                 ChannelError::CloseDelayBroadcast { msg, .. } => LightningError {
230                                         err: msg,
231                                         action: msgs::ErrorAction::SendErrorMessage {
232                                                 msg: msgs::ErrorMessage {
233                                                         channel_id,
234                                                         data: msg.to_string()
235                                                 },
236                                         },
237                                 },
238                         },
239                         shutdown_finish: None,
240                 }
241         }
242 }
243
244 /// We hold back HTLCs we intend to relay for a random interval greater than this (see
245 /// Event::PendingHTLCsForwardable for the API guidelines indicating how long should be waited).
246 /// This provides some limited amount of privacy. Ideally this would range from somewhere like one
247 /// second to 30 seconds, but people expect lightning to be, you know, kinda fast, sadly.
248 const MIN_HTLC_RELAY_HOLDING_CELL_MILLIS: u64 = 100;
249
250 /// For events which result in both a RevokeAndACK and a CommitmentUpdate, by default they should
251 /// be sent in the order they appear in the return value, however sometimes the order needs to be
252 /// variable at runtime (eg Channel::channel_reestablish needs to re-send messages in the order
253 /// they were originally sent). In those cases, this enum is also returned.
254 #[derive(Clone, PartialEq)]
255 pub(super) enum RAACommitmentOrder {
256         /// Send the CommitmentUpdate messages first
257         CommitmentFirst,
258         /// Send the RevokeAndACK message first
259         RevokeAndACKFirst,
260 }
261
262 // Note this is only exposed in cfg(test):
263 pub(super) struct ChannelHolder<ChanSigner: ChannelKeys> {
264         pub(super) by_id: HashMap<[u8; 32], Channel<ChanSigner>>,
265         pub(super) short_to_id: HashMap<u64, [u8; 32]>,
266         /// short channel id -> forward infos. Key of 0 means payments received
267         /// Note that while this is held in the same mutex as the channels themselves, no consistency
268         /// guarantees are made about the existence of a channel with the short id here, nor the short
269         /// ids in the PendingHTLCInfo!
270         pub(super) forward_htlcs: HashMap<u64, Vec<HTLCForwardInfo>>,
271         /// payment_hash -> Vec<(amount_received, htlc_source)> for tracking things that were to us and
272         /// can be failed/claimed by the user
273         /// Note that while this is held in the same mutex as the channels themselves, no consistency
274         /// guarantees are made about the channels given here actually existing anymore by the time you
275         /// go to read them!
276         pub(super) claimable_htlcs: HashMap<PaymentHash, Vec<(u64, HTLCPreviousHopData)>>,
277         /// Messages to send to peers - pushed to in the same lock that they are generated in (except
278         /// for broadcast messages, where ordering isn't as strict).
279         pub(super) pending_msg_events: Vec<events::MessageSendEvent>,
280 }
281
282 /// State we hold per-peer. In the future we should put channels in here, but for now we only hold
283 /// the latest Init features we heard from the peer.
284 struct PeerState {
285         latest_features: InitFeatures,
286 }
287
288 #[cfg(not(any(target_pointer_width = "32", target_pointer_width = "64")))]
289 const ERR: () = "You need at least 32 bit pointers (well, usize, but we'll assume they're the same) for ChannelManager::latest_block_height";
290
291 /// SimpleArcChannelManager is useful when you need a ChannelManager with a static lifetime, e.g.
292 /// when you're using lightning-net-tokio (since tokio::spawn requires parameters with static
293 /// lifetimes). Other times you can afford a reference, which is more efficient, in which case
294 /// SimpleRefChannelManager is the more appropriate type. Defining these type aliases prevents
295 /// issues such as overly long function definitions.
296 pub type SimpleArcChannelManager<M> = Arc<ChannelManager<InMemoryChannelKeys, Arc<M>>>;
297
298 /// SimpleRefChannelManager is a type alias for a ChannelManager reference, and is the reference
299 /// counterpart to the SimpleArcChannelManager type alias. Use this type by default when you don't
300 /// need a ChannelManager with a static lifetime. You'll need a static lifetime in cases such as
301 /// usage of lightning-net-tokio (since tokio::spawn requires parameters with static lifetimes).
302 /// But if this is not necessary, using a reference is more efficient. Defining these type aliases
303 /// helps with issues such as long function definitions.
304 pub type SimpleRefChannelManager<'a, M> = ChannelManager<InMemoryChannelKeys, &'a M>;
305
306 /// Manager which keeps track of a number of channels and sends messages to the appropriate
307 /// channel, also tracking HTLC preimages and forwarding onion packets appropriately.
308 ///
309 /// Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
310 /// to individual Channels.
311 ///
312 /// Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
313 /// all peers during write/read (though does not modify this instance, only the instance being
314 /// serialized). This will result in any channels which have not yet exchanged funding_created (ie
315 /// called funding_transaction_generated for outbound channels).
316 ///
317 /// Note that you can be a bit lazier about writing out ChannelManager than you can be with
318 /// ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
319 /// returning from ManyChannelMonitor::add_update_monitor, with ChannelManagers, writing updates
320 /// happens out-of-band (and will prevent any other ChannelManager operations from occurring during
321 /// the serialization process). If the deserialized version is out-of-date compared to the
322 /// ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
323 /// ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
324 ///
325 /// Note that the deserializer is only implemented for (Sha256dHash, ChannelManager), which
326 /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
327 /// the "reorg path" (ie call block_disconnected() until you get to a common block and then call
328 /// block_connected() to step towards your best block) upon deserialization before using the
329 /// object!
330 ///
331 /// Note that ChannelManager is responsible for tracking liveness of its channels and generating
332 /// ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
333 /// spam due to quick disconnection/reconnection, updates are not sent until the channel has been
334 /// offline for a full minute. In order to track this, you must call
335 /// timer_chan_freshness_every_min roughly once per minute, though it doesn't have to be perfect.
336 ///
337 /// Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
338 /// a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
339 /// essentially you should default to using a SimpleRefChannelManager, and use a
340 /// SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
341 /// you're using lightning-net-tokio.
342 pub struct ChannelManager<ChanSigner: ChannelKeys, M: Deref> where M::Target: ManyChannelMonitor {
343         default_configuration: UserConfig,
344         genesis_hash: Sha256dHash,
345         fee_estimator: Arc<FeeEstimator>,
346         monitor: M,
347         tx_broadcaster: Arc<BroadcasterInterface>,
348
349         #[cfg(test)]
350         pub(super) latest_block_height: AtomicUsize,
351         #[cfg(not(test))]
352         latest_block_height: AtomicUsize,
353         last_block_hash: Mutex<Sha256dHash>,
354         secp_ctx: Secp256k1<secp256k1::All>,
355
356         #[cfg(test)]
357         pub(super) channel_state: Mutex<ChannelHolder<ChanSigner>>,
358         #[cfg(not(test))]
359         channel_state: Mutex<ChannelHolder<ChanSigner>>,
360         our_network_key: SecretKey,
361
362         last_node_announcement_serial: AtomicUsize,
363
364         /// The bulk of our storage will eventually be here (channels and message queues and the like).
365         /// If we are connected to a peer we always at least have an entry here, even if no channels
366         /// are currently open with that peer.
367         /// Because adding or removing an entry is rare, we usually take an outer read lock and then
368         /// operate on the inner value freely. Sadly, this prevents parallel operation when opening a
369         /// new channel.
370         per_peer_state: RwLock<HashMap<PublicKey, Mutex<PeerState>>>,
371
372         pending_events: Mutex<Vec<events::Event>>,
373         /// Used when we have to take a BIG lock to make sure everything is self-consistent.
374         /// Essentially just when we're serializing ourselves out.
375         /// Taken first everywhere where we are making changes before any other locks.
376         total_consistency_lock: RwLock<()>,
377
378         keys_manager: Arc<KeysInterface<ChanKeySigner = ChanSigner>>,
379
380         logger: Arc<Logger>,
381 }
382
383 /// The amount of time we require our counterparty wait to claim their money (ie time between when
384 /// we, or our watchtower, must check for them having broadcast a theft transaction).
385 pub(crate) const BREAKDOWN_TIMEOUT: u16 = 6 * 24;
386 /// The amount of time we're willing to wait to claim money back to us
387 pub(crate) const MAX_LOCAL_BREAKDOWN_TIMEOUT: u16 = 6 * 24 * 7;
388
389 /// The minimum number of blocks between an inbound HTLC's CLTV and the corresponding outbound
390 /// HTLC's CLTV. This should always be a few blocks greater than channelmonitor::CLTV_CLAIM_BUFFER,
391 /// ie the node we forwarded the payment on to should always have enough room to reliably time out
392 /// the HTLC via a full update_fail_htlc/commitment_signed dance before we hit the
393 /// CLTV_CLAIM_BUFFER point (we static assert that it's at least 3 blocks more).
394 const CLTV_EXPIRY_DELTA: u16 = 6 * 12; //TODO?
395 pub(super) const CLTV_FAR_FAR_AWAY: u32 = 6 * 24 * 7; //TODO?
396
397 // Check that our CLTV_EXPIRY is at least CLTV_CLAIM_BUFFER + ANTI_REORG_DELAY + LATENCY_GRACE_PERIOD_BLOCKS,
398 // ie that if the next-hop peer fails the HTLC within
399 // LATENCY_GRACE_PERIOD_BLOCKS then we'll still have CLTV_CLAIM_BUFFER left to timeout it onchain,
400 // then waiting ANTI_REORG_DELAY to be reorg-safe on the outbound HLTC and
401 // failing the corresponding htlc backward, and us now seeing the last block of ANTI_REORG_DELAY before
402 // LATENCY_GRACE_PERIOD_BLOCKS.
403 #[deny(const_err)]
404 #[allow(dead_code)]
405 const CHECK_CLTV_EXPIRY_SANITY: u32 = CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - CLTV_CLAIM_BUFFER - ANTI_REORG_DELAY - LATENCY_GRACE_PERIOD_BLOCKS;
406
407 // Check for ability of an attacker to make us fail on-chain by delaying inbound claim. See
408 // ChannelMontior::would_broadcast_at_height for a description of why this is needed.
409 #[deny(const_err)]
410 #[allow(dead_code)]
411 const CHECK_CLTV_EXPIRY_SANITY_2: u32 = CLTV_EXPIRY_DELTA as u32 - LATENCY_GRACE_PERIOD_BLOCKS - 2*CLTV_CLAIM_BUFFER;
412
413 macro_rules! secp_call {
414         ( $res: expr, $err: expr ) => {
415                 match $res {
416                         Ok(key) => key,
417                         Err(_) => return Err($err),
418                 }
419         };
420 }
421
422 /// Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
423 pub struct ChannelDetails {
424         /// The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
425         /// thereafter this is the txid of the funding transaction xor the funding transaction output).
426         /// Note that this means this value is *not* persistent - it can change once during the
427         /// lifetime of the channel.
428         pub channel_id: [u8; 32],
429         /// The position of the funding transaction in the chain. None if the funding transaction has
430         /// not yet been confirmed and the channel fully opened.
431         pub short_channel_id: Option<u64>,
432         /// The node_id of our counterparty
433         pub remote_network_id: PublicKey,
434         /// The Features the channel counterparty provided upon last connection.
435         /// Useful for routing as it is the most up-to-date copy of the counterparty's features and
436         /// many routing-relevant features are present in the init context.
437         pub counterparty_features: InitFeatures,
438         /// The value, in satoshis, of this channel as appears in the funding output
439         pub channel_value_satoshis: u64,
440         /// The user_id passed in to create_channel, or 0 if the channel was inbound.
441         pub user_id: u64,
442         /// The available outbound capacity for sending HTLCs to the remote peer. This does not include
443         /// any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
444         /// available for inclusion in new outbound HTLCs). This further does not include any pending
445         /// outgoing HTLCs which are awaiting some other resolution to be sent.
446         pub outbound_capacity_msat: u64,
447         /// The available inbound capacity for the remote peer to send HTLCs to us. This does not
448         /// include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
449         /// available for inclusion in new inbound HTLCs).
450         /// Note that there are some corner cases not fully handled here, so the actual available
451         /// inbound capacity may be slightly higher than this.
452         pub inbound_capacity_msat: u64,
453         /// True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
454         /// the peer is connected, and (c) no monitor update failure is pending resolution.
455         pub is_live: bool,
456 }
457
458 macro_rules! handle_error {
459         ($self: ident, $internal: expr, $their_node_id: expr, $locked_channel_state: expr) => {
460                 match $internal {
461                         Ok(msg) => Ok(msg),
462                         Err(MsgHandleErrInternal { err, shutdown_finish }) => {
463                                 if let Some((shutdown_res, update_option)) = shutdown_finish {
464                                         $self.finish_force_close_channel(shutdown_res);
465                                         if let Some(update) = update_option {
466                                                 $locked_channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
467                                                         msg: update
468                                                 });
469                                         }
470                                 }
471                                 log_error!($self, "{}", err.err);
472                                 if let msgs::ErrorAction::IgnoreError = err.action {
473                                 } else { $locked_channel_state.pending_msg_events.push(events::MessageSendEvent::HandleError { node_id: $their_node_id, action: err.action.clone() }); }
474                                 // Return error in case higher-API need one
475                                 Err(err)
476                         },
477                 }
478         }
479 }
480
481 macro_rules! break_chan_entry {
482         ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
483                 match $res {
484                         Ok(res) => res,
485                         Err(ChannelError::Ignore(msg)) => {
486                                 break Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
487                         },
488                         Err(ChannelError::Close(msg)) => {
489                                 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
490                                 let (channel_id, mut chan) = $entry.remove_entry();
491                                 if let Some(short_id) = chan.get_short_channel_id() {
492                                         $channel_state.short_to_id.remove(&short_id);
493                                 }
494                                 break Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
495                         },
496                         Err(ChannelError::CloseDelayBroadcast { .. }) => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
497                 }
498         }
499 }
500
501 macro_rules! try_chan_entry {
502         ($self: ident, $res: expr, $channel_state: expr, $entry: expr) => {
503                 match $res {
504                         Ok(res) => res,
505                         Err(ChannelError::Ignore(msg)) => {
506                                 return Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore(msg), $entry.key().clone()))
507                         },
508                         Err(ChannelError::Close(msg)) => {
509                                 log_trace!($self, "Closing channel {} due to Close-required error: {}", log_bytes!($entry.key()[..]), msg);
510                                 let (channel_id, mut chan) = $entry.remove_entry();
511                                 if let Some(short_id) = chan.get_short_channel_id() {
512                                         $channel_state.short_to_id.remove(&short_id);
513                                 }
514                                 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()))
515                         },
516                         Err(ChannelError::CloseDelayBroadcast { msg, update }) => {
517                                 log_error!($self, "Channel {} need to be shutdown but closing transactions not broadcast due to {}", log_bytes!($entry.key()[..]), msg);
518                                 let (channel_id, mut chan) = $entry.remove_entry();
519                                 if let Some(short_id) = chan.get_short_channel_id() {
520                                         $channel_state.short_to_id.remove(&short_id);
521                                 }
522                                 if let Some(update) = update {
523                                         if let Err(e) = $self.monitor.add_update_monitor(update.get_funding_txo().unwrap(), update) {
524                                                 match e {
525                                                         // Upstream channel is dead, but we want at least to fail backward HTLCs to save
526                                                         // downstream channels. In case of PermanentFailure, we are not going to be able
527                                                         // to claim back to_remote output on remote commitment transaction. Doesn't
528                                                         // make a difference here, we are concern about HTLCs circuit, not onchain funds.
529                                                         ChannelMonitorUpdateErr::PermanentFailure => {},
530                                                         ChannelMonitorUpdateErr::TemporaryFailure => {},
531                                                 }
532                                         }
533                                 }
534                                 let mut shutdown_res = chan.force_shutdown();
535                                 if shutdown_res.0.len() >= 1 {
536                                         log_error!($self, "You have a toxic local commitment transaction {} avaible in channel monitor, read comment in ChannelMonitor::get_latest_local_commitment_txn to be informed of manual action to take", shutdown_res.0[0].txid());
537                                 }
538                                 shutdown_res.0.clear();
539                                 return Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, shutdown_res, $self.get_channel_update(&chan).ok()))
540                         }
541                 }
542         }
543 }
544
545 macro_rules! handle_monitor_err {
546         ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
547                 handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, Vec::new(), Vec::new())
548         };
549         ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
550                 match $err {
551                         ChannelMonitorUpdateErr::PermanentFailure => {
552                                 log_error!($self, "Closing channel {} due to monitor update PermanentFailure", log_bytes!($entry.key()[..]));
553                                 let (channel_id, mut chan) = $entry.remove_entry();
554                                 if let Some(short_id) = chan.get_short_channel_id() {
555                                         $channel_state.short_to_id.remove(&short_id);
556                                 }
557                                 // TODO: $failed_fails is dropped here, which will cause other channels to hit the
558                                 // chain in a confused state! We need to move them into the ChannelMonitor which
559                                 // will be responsible for failing backwards once things confirm on-chain.
560                                 // It's ok that we drop $failed_forwards here - at this point we'd rather they
561                                 // broadcast HTLC-Timeout and pay the associated fees to get their funds back than
562                                 // us bother trying to claim it just to forward on to another peer. If we're
563                                 // splitting hairs we'd prefer to claim payments that were to us, but we haven't
564                                 // given up the preimage yet, so might as well just wait until the payment is
565                                 // retried, avoiding the on-chain fees.
566                                 let res: Result<(), _> = Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", channel_id, chan.force_shutdown(), $self.get_channel_update(&chan).ok()));
567                                 res
568                         },
569                         ChannelMonitorUpdateErr::TemporaryFailure => {
570                                 log_info!($self, "Disabling channel {} due to monitor update TemporaryFailure. On restore will send {} and process {} forwards and {} fails",
571                                                 log_bytes!($entry.key()[..]),
572                                                 if $resend_commitment && $resend_raa {
573                                                                 match $action_type {
574                                                                         RAACommitmentOrder::CommitmentFirst => { "commitment then RAA" },
575                                                                         RAACommitmentOrder::RevokeAndACKFirst => { "RAA then commitment" },
576                                                                 }
577                                                         } else if $resend_commitment { "commitment" }
578                                                         else if $resend_raa { "RAA" }
579                                                         else { "nothing" },
580                                                 (&$failed_forwards as &Vec<(PendingHTLCInfo, u64)>).len(),
581                                                 (&$failed_fails as &Vec<(HTLCSource, PaymentHash, HTLCFailReason)>).len());
582                                 if !$resend_commitment {
583                                         debug_assert!($action_type == RAACommitmentOrder::RevokeAndACKFirst || !$resend_raa);
584                                 }
585                                 if !$resend_raa {
586                                         debug_assert!($action_type == RAACommitmentOrder::CommitmentFirst || !$resend_commitment);
587                                 }
588                                 $entry.get_mut().monitor_update_failed($resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
589                                 Err(MsgHandleErrInternal::from_chan_no_close(ChannelError::Ignore("Failed to update ChannelMonitor"), *$entry.key()))
590                         },
591                 }
592         }
593 }
594
595 macro_rules! return_monitor_err {
596         ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
597                 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment);
598         };
599         ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr, $failed_forwards: expr, $failed_fails: expr) => {
600                 return handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment, $failed_forwards, $failed_fails);
601         }
602 }
603
604 // Does not break in case of TemporaryFailure!
605 macro_rules! maybe_break_monitor_err {
606         ($self: ident, $err: expr, $channel_state: expr, $entry: expr, $action_type: path, $resend_raa: expr, $resend_commitment: expr) => {
607                 match (handle_monitor_err!($self, $err, $channel_state, $entry, $action_type, $resend_raa, $resend_commitment), $err) {
608                         (e, ChannelMonitorUpdateErr::PermanentFailure) => {
609                                 break e;
610                         },
611                         (_, ChannelMonitorUpdateErr::TemporaryFailure) => { },
612                 }
613         }
614 }
615
616 impl<ChanSigner: ChannelKeys, M: Deref> ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor {
617         /// Constructs a new ChannelManager to hold several channels and route between them.
618         ///
619         /// This is the main "logic hub" for all channel-related actions, and implements
620         /// ChannelMessageHandler.
621         ///
622         /// Non-proportional fees are fixed according to our risk using the provided fee estimator.
623         ///
624         /// panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
625         ///
626         /// Users must provide the current blockchain height from which to track onchain channel
627         /// funding outpoints and send payments with reliable timelocks.
628         ///
629         /// Users need to notify the new ChannelManager when a new block is connected or
630         /// disconnected using its `block_connected` and `block_disconnected` methods.
631         /// However, rather than calling these methods directly, the user should register
632         /// the ChannelManager as a listener to the BlockNotifier and call the BlockNotifier's
633         /// `block_(dis)connected` methods, which will notify all registered listeners in one
634         /// go.
635         pub fn new(network: Network, feeest: Arc<FeeEstimator>, monitor: M, tx_broadcaster: Arc<BroadcasterInterface>, logger: Arc<Logger>,keys_manager: Arc<KeysInterface<ChanKeySigner = ChanSigner>>, config: UserConfig, current_blockchain_height: usize) -> Result<ChannelManager<ChanSigner, M>, secp256k1::Error> {
636                 let secp_ctx = Secp256k1::new();
637
638                 let res = ChannelManager {
639                         default_configuration: config.clone(),
640                         genesis_hash: genesis_block(network).header.bitcoin_hash(),
641                         fee_estimator: feeest.clone(),
642                         monitor,
643                         tx_broadcaster,
644
645                         latest_block_height: AtomicUsize::new(current_blockchain_height),
646                         last_block_hash: Mutex::new(Default::default()),
647                         secp_ctx,
648
649                         channel_state: Mutex::new(ChannelHolder{
650                                 by_id: HashMap::new(),
651                                 short_to_id: HashMap::new(),
652                                 forward_htlcs: HashMap::new(),
653                                 claimable_htlcs: HashMap::new(),
654                                 pending_msg_events: Vec::new(),
655                         }),
656                         our_network_key: keys_manager.get_node_secret(),
657
658                         last_node_announcement_serial: AtomicUsize::new(0),
659
660                         per_peer_state: RwLock::new(HashMap::new()),
661
662                         pending_events: Mutex::new(Vec::new()),
663                         total_consistency_lock: RwLock::new(()),
664
665                         keys_manager,
666
667                         logger,
668                 };
669
670                 Ok(res)
671         }
672
673         /// Creates a new outbound channel to the given remote node and with the given value.
674         ///
675         /// user_id will be provided back as user_channel_id in FundingGenerationReady and
676         /// FundingBroadcastSafe events to allow tracking of which events correspond with which
677         /// create_channel call. Note that user_channel_id defaults to 0 for inbound channels, so you
678         /// may wish to avoid using 0 for user_id here.
679         ///
680         /// If successful, will generate a SendOpenChannel message event, so you should probably poll
681         /// PeerManager::process_events afterwards.
682         ///
683         /// Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
684         /// greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
685         pub fn create_channel(&self, their_network_key: PublicKey, channel_value_satoshis: u64, push_msat: u64, user_id: u64) -> Result<(), APIError> {
686                 if channel_value_satoshis < 1000 {
687                         return Err(APIError::APIMisuseError { err: "channel_value must be at least 1000 satoshis" });
688                 }
689
690                 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)?;
691                 let res = channel.get_open_channel(self.genesis_hash.clone(), &*self.fee_estimator);
692
693                 let _ = self.total_consistency_lock.read().unwrap();
694                 let mut channel_state = self.channel_state.lock().unwrap();
695                 match channel_state.by_id.entry(channel.channel_id()) {
696                         hash_map::Entry::Occupied(_) => {
697                                 if cfg!(feature = "fuzztarget") {
698                                         return Err(APIError::APIMisuseError { err: "Fuzzy bad RNG" });
699                                 } else {
700                                         panic!("RNG is bad???");
701                                 }
702                         },
703                         hash_map::Entry::Vacant(entry) => { entry.insert(channel); }
704                 }
705                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendOpenChannel {
706                         node_id: their_network_key,
707                         msg: res,
708                 });
709                 Ok(())
710         }
711
712         fn list_channels_with_filter<F: FnMut(&(&[u8; 32], &Channel<ChanSigner>)) -> bool>(&self, f: F) -> Vec<ChannelDetails> {
713                 let mut res = Vec::new();
714                 {
715                         let channel_state = self.channel_state.lock().unwrap();
716                         res.reserve(channel_state.by_id.len());
717                         for (channel_id, channel) in channel_state.by_id.iter().filter(f) {
718                                 let (inbound_capacity_msat, outbound_capacity_msat) = channel.get_inbound_outbound_available_balance_msat();
719                                 res.push(ChannelDetails {
720                                         channel_id: (*channel_id).clone(),
721                                         short_channel_id: channel.get_short_channel_id(),
722                                         remote_network_id: channel.get_their_node_id(),
723                                         counterparty_features: InitFeatures::empty(),
724                                         channel_value_satoshis: channel.get_value_satoshis(),
725                                         inbound_capacity_msat,
726                                         outbound_capacity_msat,
727                                         user_id: channel.get_user_id(),
728                                         is_live: channel.is_live(),
729                                 });
730                         }
731                 }
732                 let per_peer_state = self.per_peer_state.read().unwrap();
733                 for chan in res.iter_mut() {
734                         if let Some(peer_state) = per_peer_state.get(&chan.remote_network_id) {
735                                 chan.counterparty_features = peer_state.lock().unwrap().latest_features.clone();
736                         }
737                 }
738                 res
739         }
740
741         /// Gets the list of open channels, in random order. See ChannelDetail field documentation for
742         /// more information.
743         pub fn list_channels(&self) -> Vec<ChannelDetails> {
744                 self.list_channels_with_filter(|_| true)
745         }
746
747         /// Gets the list of usable channels, in random order. Useful as an argument to
748         /// Router::get_route to ensure non-announced channels are used.
749         ///
750         /// These are guaranteed to have their is_live value set to true, see the documentation for
751         /// ChannelDetails::is_live for more info on exactly what the criteria are.
752         pub fn list_usable_channels(&self) -> Vec<ChannelDetails> {
753                 // Note we use is_live here instead of usable which leads to somewhat confused
754                 // internal/external nomenclature, but that's ok cause that's probably what the user
755                 // really wanted anyway.
756                 self.list_channels_with_filter(|&(_, ref channel)| channel.is_live())
757         }
758
759         /// Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
760         /// will be accepted on the given channel, and after additional timeout/the closing of all
761         /// pending HTLCs, the channel will be closed on chain.
762         ///
763         /// May generate a SendShutdown message event on success, which should be relayed.
764         pub fn close_channel(&self, channel_id: &[u8; 32]) -> Result<(), APIError> {
765                 let _ = self.total_consistency_lock.read().unwrap();
766
767                 let (mut failed_htlcs, chan_option) = {
768                         let mut channel_state_lock = self.channel_state.lock().unwrap();
769                         let channel_state = &mut *channel_state_lock;
770                         match channel_state.by_id.entry(channel_id.clone()) {
771                                 hash_map::Entry::Occupied(mut chan_entry) => {
772                                         let (shutdown_msg, failed_htlcs) = chan_entry.get_mut().get_shutdown()?;
773                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
774                                                 node_id: chan_entry.get().get_their_node_id(),
775                                                 msg: shutdown_msg
776                                         });
777                                         if chan_entry.get().is_shutdown() {
778                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
779                                                         channel_state.short_to_id.remove(&short_id);
780                                                 }
781                                                 (failed_htlcs, Some(chan_entry.remove_entry().1))
782                                         } else { (failed_htlcs, None) }
783                                 },
784                                 hash_map::Entry::Vacant(_) => return Err(APIError::ChannelUnavailable{err: "No such channel"})
785                         }
786                 };
787                 for htlc_source in failed_htlcs.drain(..) {
788                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
789                 }
790                 let chan_update = if let Some(chan) = chan_option {
791                         if let Ok(update) = self.get_channel_update(&chan) {
792                                 Some(update)
793                         } else { None }
794                 } else { None };
795
796                 if let Some(update) = chan_update {
797                         let mut channel_state = self.channel_state.lock().unwrap();
798                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
799                                 msg: update
800                         });
801                 }
802
803                 Ok(())
804         }
805
806         #[inline]
807         fn finish_force_close_channel(&self, shutdown_res: ShutdownResult) {
808                 let (local_txn, mut failed_htlcs) = shutdown_res;
809                 log_trace!(self, "Finishing force-closure of channel with {} transactions to broadcast and {} HTLCs to fail", local_txn.len(), failed_htlcs.len());
810                 for htlc_source in failed_htlcs.drain(..) {
811                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
812                 }
813                 for tx in local_txn {
814                         log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
815                         self.tx_broadcaster.broadcast_transaction(&tx);
816                 }
817         }
818
819         /// Force closes a channel, immediately broadcasting the latest local commitment transaction to
820         /// the chain and rejecting new HTLCs on the given channel.
821         pub fn force_close_channel(&self, channel_id: &[u8; 32]) {
822                 let _ = self.total_consistency_lock.read().unwrap();
823
824                 let mut chan = {
825                         let mut channel_state_lock = self.channel_state.lock().unwrap();
826                         let channel_state = &mut *channel_state_lock;
827                         if let Some(chan) = channel_state.by_id.remove(channel_id) {
828                                 if let Some(short_id) = chan.get_short_channel_id() {
829                                         channel_state.short_to_id.remove(&short_id);
830                                 }
831                                 chan
832                         } else {
833                                 return;
834                         }
835                 };
836                 log_trace!(self, "Force-closing channel {}", log_bytes!(channel_id[..]));
837                 self.finish_force_close_channel(chan.force_shutdown());
838                 if let Ok(update) = self.get_channel_update(&chan) {
839                         let mut channel_state = self.channel_state.lock().unwrap();
840                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
841                                 msg: update
842                         });
843                 }
844         }
845
846         /// Force close all channels, immediately broadcasting the latest local commitment transaction
847         /// for each to the chain and rejecting new HTLCs on each.
848         pub fn force_close_all_channels(&self) {
849                 for chan in self.list_channels() {
850                         self.force_close_channel(&chan.channel_id);
851                 }
852         }
853
854         fn decode_update_add_htlc_onion(&self, msg: &msgs::UpdateAddHTLC) -> (PendingHTLCStatus, MutexGuard<ChannelHolder<ChanSigner>>) {
855                 macro_rules! return_malformed_err {
856                         ($msg: expr, $err_code: expr) => {
857                                 {
858                                         log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
859                                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Malformed(msgs::UpdateFailMalformedHTLC {
860                                                 channel_id: msg.channel_id,
861                                                 htlc_id: msg.htlc_id,
862                                                 sha256_of_onion: Sha256::hash(&msg.onion_routing_packet.hop_data).into_inner(),
863                                                 failure_code: $err_code,
864                                         })), self.channel_state.lock().unwrap());
865                                 }
866                         }
867                 }
868
869                 if let Err(_) = msg.onion_routing_packet.public_key {
870                         return_malformed_err!("invalid ephemeral pubkey", 0x8000 | 0x4000 | 6);
871                 }
872
873                 let shared_secret = {
874                         let mut arr = [0; 32];
875                         arr.copy_from_slice(&SharedSecret::new(&msg.onion_routing_packet.public_key.unwrap(), &self.our_network_key)[..]);
876                         arr
877                 };
878                 let (rho, mu) = onion_utils::gen_rho_mu_from_shared_secret(&shared_secret);
879
880                 if msg.onion_routing_packet.version != 0 {
881                         //TODO: Spec doesn't indicate if we should only hash hop_data here (and in other
882                         //sha256_of_onion error data packets), or the entire onion_routing_packet. Either way,
883                         //the hash doesn't really serve any purpose - in the case of hashing all data, the
884                         //receiving node would have to brute force to figure out which version was put in the
885                         //packet by the node that send us the message, in the case of hashing the hop_data, the
886                         //node knows the HMAC matched, so they already know what is there...
887                         return_malformed_err!("Unknown onion packet version", 0x8000 | 0x4000 | 4);
888                 }
889
890                 let mut hmac = HmacEngine::<Sha256>::new(&mu);
891                 hmac.input(&msg.onion_routing_packet.hop_data);
892                 hmac.input(&msg.payment_hash.0[..]);
893                 if !fixed_time_eq(&Hmac::from_engine(hmac).into_inner(), &msg.onion_routing_packet.hmac) {
894                         return_malformed_err!("HMAC Check failed", 0x8000 | 0x4000 | 5);
895                 }
896
897                 let mut channel_state = None;
898                 macro_rules! return_err {
899                         ($msg: expr, $err_code: expr, $data: expr) => {
900                                 {
901                                         log_info!(self, "Failed to accept/forward incoming HTLC: {}", $msg);
902                                         if channel_state.is_none() {
903                                                 channel_state = Some(self.channel_state.lock().unwrap());
904                                         }
905                                         return (PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
906                                                 channel_id: msg.channel_id,
907                                                 htlc_id: msg.htlc_id,
908                                                 reason: onion_utils::build_first_hop_failure_packet(&shared_secret, $err_code, $data),
909                                         })), channel_state.unwrap());
910                                 }
911                         }
912                 }
913
914                 let mut chacha = ChaCha20::new(&rho, &[0u8; 8]);
915                 let mut chacha_stream = ChaChaReader { chacha: &mut chacha, read: Cursor::new(&msg.onion_routing_packet.hop_data[..]) };
916                 let (next_hop_data, next_hop_hmac) = {
917                         match msgs::OnionHopData::read(&mut chacha_stream) {
918                                 Err(err) => {
919                                         let error_code = match err {
920                                                 msgs::DecodeError::UnknownVersion => 0x4000 | 1, // unknown realm byte
921                                                 msgs::DecodeError::UnknownRequiredFeature|
922                                                 msgs::DecodeError::InvalidValue|
923                                                 msgs::DecodeError::ShortRead => 0x4000 | 22, // invalid_onion_payload
924                                                 _ => 0x2000 | 2, // Should never happen
925                                         };
926                                         return_err!("Unable to decode our hop data", error_code, &[0;0]);
927                                 },
928                                 Ok(msg) => {
929                                         let mut hmac = [0; 32];
930                                         if let Err(_) = chacha_stream.read_exact(&mut hmac[..]) {
931                                                 return_err!("Unable to decode hop data", 0x4000 | 22, &[0;0]);
932                                         }
933                                         (msg, hmac)
934                                 },
935                         }
936                 };
937
938                 let pending_forward_info = if next_hop_hmac == [0; 32] {
939                                 #[cfg(test)]
940                                 {
941                                         // In tests, make sure that the initial onion pcket data is, at least, non-0.
942                                         // We could do some fancy randomness test here, but, ehh, whatever.
943                                         // This checks for the issue where you can calculate the path length given the
944                                         // onion data as all the path entries that the originator sent will be here
945                                         // as-is (and were originally 0s).
946                                         // Of course reverse path calculation is still pretty easy given naive routing
947                                         // algorithms, but this fixes the most-obvious case.
948                                         let mut next_bytes = [0; 32];
949                                         chacha_stream.read_exact(&mut next_bytes).unwrap();
950                                         assert_ne!(next_bytes[..], [0; 32][..]);
951                                         chacha_stream.read_exact(&mut next_bytes).unwrap();
952                                         assert_ne!(next_bytes[..], [0; 32][..]);
953                                 }
954
955                                 // OUR PAYMENT!
956                                 // final_expiry_too_soon
957                                 if (msg.cltv_expiry as u64) < self.latest_block_height.load(Ordering::Acquire) as u64 + (CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS) as u64 {
958                                         return_err!("The final CLTV expiry is too soon to handle", 17, &[0;0]);
959                                 }
960                                 // final_incorrect_htlc_amount
961                                 if next_hop_data.amt_to_forward > msg.amount_msat {
962                                         return_err!("Upstream node sent less than we were supposed to receive in payment", 19, &byte_utils::be64_to_array(msg.amount_msat));
963                                 }
964                                 // final_incorrect_cltv_expiry
965                                 if next_hop_data.outgoing_cltv_value != msg.cltv_expiry {
966                                         return_err!("Upstream node set CLTV to the wrong value", 18, &byte_utils::be32_to_array(msg.cltv_expiry));
967                                 }
968
969                                 // Note that we could obviously respond immediately with an update_fulfill_htlc
970                                 // message, however that would leak that we are the recipient of this payment, so
971                                 // instead we stay symmetric with the forwarding case, only responding (after a
972                                 // delay) once they've send us a commitment_signed!
973
974                                 PendingHTLCStatus::Forward(PendingHTLCInfo {
975                                         onion_packet: None,
976                                         payment_hash: msg.payment_hash.clone(),
977                                         short_channel_id: 0,
978                                         incoming_shared_secret: shared_secret,
979                                         amt_to_forward: next_hop_data.amt_to_forward,
980                                         outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
981                                 })
982                         } else {
983                                 let mut new_packet_data = [0; 20*65];
984                                 let read_pos = chacha_stream.read(&mut new_packet_data).unwrap();
985                                 #[cfg(debug_assertions)]
986                                 {
987                                         // Check two things:
988                                         // a) that the behavior of our stream here will return Ok(0) even if the TLV
989                                         //    read above emptied out our buffer and the unwrap() wont needlessly panic
990                                         // b) that we didn't somehow magically end up with extra data.
991                                         let mut t = [0; 1];
992                                         debug_assert!(chacha_stream.read(&mut t).unwrap() == 0);
993                                 }
994                                 // Once we've emptied the set of bytes our peer gave us, encrypt 0 bytes until we
995                                 // fill the onion hop data we'll forward to our next-hop peer.
996                                 chacha_stream.chacha.process_in_place(&mut new_packet_data[read_pos..]);
997
998                                 let mut new_pubkey = msg.onion_routing_packet.public_key.unwrap();
999
1000                                 let blinding_factor = {
1001                                         let mut sha = Sha256::engine();
1002                                         sha.input(&new_pubkey.serialize()[..]);
1003                                         sha.input(&shared_secret);
1004                                         Sha256::from_engine(sha).into_inner()
1005                                 };
1006
1007                                 let public_key = if let Err(e) = new_pubkey.mul_assign(&self.secp_ctx, &blinding_factor[..]) {
1008                                         Err(e)
1009                                 } else { Ok(new_pubkey) };
1010
1011                                 let outgoing_packet = msgs::OnionPacket {
1012                                         version: 0,
1013                                         public_key,
1014                                         hop_data: new_packet_data,
1015                                         hmac: next_hop_hmac.clone(),
1016                                 };
1017
1018                                 let short_channel_id = match next_hop_data.format {
1019                                         msgs::OnionHopDataFormat::Legacy { short_channel_id } => short_channel_id,
1020                                         msgs::OnionHopDataFormat::NonFinalNode { short_channel_id } => short_channel_id,
1021                                         msgs::OnionHopDataFormat::FinalNode => {
1022                                                 return_err!("Final Node OnionHopData provided for us as an intermediary node", 0x4000 | 22, &[0;0]);
1023                                         },
1024                                 };
1025
1026                                 PendingHTLCStatus::Forward(PendingHTLCInfo {
1027                                         onion_packet: Some(outgoing_packet),
1028                                         payment_hash: msg.payment_hash.clone(),
1029                                         short_channel_id: short_channel_id,
1030                                         incoming_shared_secret: shared_secret,
1031                                         amt_to_forward: next_hop_data.amt_to_forward,
1032                                         outgoing_cltv_value: next_hop_data.outgoing_cltv_value,
1033                                 })
1034                         };
1035
1036                 channel_state = Some(self.channel_state.lock().unwrap());
1037                 if let &PendingHTLCStatus::Forward(PendingHTLCInfo { ref onion_packet, ref short_channel_id, ref amt_to_forward, ref outgoing_cltv_value, .. }) = &pending_forward_info {
1038                         if onion_packet.is_some() { // If short_channel_id is 0 here, we'll reject them in the body here
1039                                 let id_option = channel_state.as_ref().unwrap().short_to_id.get(&short_channel_id).cloned();
1040                                 let forwarding_id = match id_option {
1041                                         None => { // unknown_next_peer
1042                                                 return_err!("Don't have available channel for forwarding as requested.", 0x4000 | 10, &[0;0]);
1043                                         },
1044                                         Some(id) => id.clone(),
1045                                 };
1046                                 if let Some((err, code, chan_update)) = loop {
1047                                         let chan = channel_state.as_mut().unwrap().by_id.get_mut(&forwarding_id).unwrap();
1048
1049                                         // Note that we could technically not return an error yet here and just hope
1050                                         // that the connection is reestablished or monitor updated by the time we get
1051                                         // around to doing the actual forward, but better to fail early if we can and
1052                                         // hopefully an attacker trying to path-trace payments cannot make this occur
1053                                         // on a small/per-node/per-channel scale.
1054                                         if !chan.is_live() { // channel_disabled
1055                                                 break Some(("Forwarding channel is not in a ready state.", 0x1000 | 20, Some(self.get_channel_update(chan).unwrap())));
1056                                         }
1057                                         if *amt_to_forward < chan.get_their_htlc_minimum_msat() { // amount_below_minimum
1058                                                 break Some(("HTLC amount was below the htlc_minimum_msat", 0x1000 | 11, Some(self.get_channel_update(chan).unwrap())));
1059                                         }
1060                                         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) });
1061                                         if fee.is_none() || msg.amount_msat < fee.unwrap() || (msg.amount_msat - fee.unwrap()) < *amt_to_forward { // fee_insufficient
1062                                                 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())));
1063                                         }
1064                                         if (msg.cltv_expiry as u64) < (*outgoing_cltv_value) as u64 + CLTV_EXPIRY_DELTA as u64 { // incorrect_cltv_expiry
1065                                                 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())));
1066                                         }
1067                                         let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1068                                         // We want to have at least LATENCY_GRACE_PERIOD_BLOCKS to fail prior to going on chain CLAIM_BUFFER blocks before expiration
1069                                         if msg.cltv_expiry <= cur_height + CLTV_CLAIM_BUFFER + LATENCY_GRACE_PERIOD_BLOCKS as u32 { // expiry_too_soon
1070                                                 break Some(("CLTV expiry is too close", 0x1000 | 14, Some(self.get_channel_update(chan).unwrap())));
1071                                         }
1072                                         if msg.cltv_expiry > cur_height + CLTV_FAR_FAR_AWAY as u32 { // expiry_too_far
1073                                                 break Some(("CLTV expiry is too far in the future", 21, None));
1074                                         }
1075                                         break None;
1076                                 }
1077                                 {
1078                                         let mut res = Vec::with_capacity(8 + 128);
1079                                         if let Some(chan_update) = chan_update {
1080                                                 if code == 0x1000 | 11 || code == 0x1000 | 12 {
1081                                                         res.extend_from_slice(&byte_utils::be64_to_array(msg.amount_msat));
1082                                                 }
1083                                                 else if code == 0x1000 | 13 {
1084                                                         res.extend_from_slice(&byte_utils::be32_to_array(msg.cltv_expiry));
1085                                                 }
1086                                                 else if code == 0x1000 | 20 {
1087                                                         res.extend_from_slice(&byte_utils::be16_to_array(chan_update.contents.flags));
1088                                                 }
1089                                                 res.extend_from_slice(&chan_update.encode_with_len()[..]);
1090                                         }
1091                                         return_err!(err, code, &res[..]);
1092                                 }
1093                         }
1094                 }
1095
1096                 (pending_forward_info, channel_state.unwrap())
1097         }
1098
1099         /// only fails if the channel does not yet have an assigned short_id
1100         /// May be called with channel_state already locked!
1101         fn get_channel_update(&self, chan: &Channel<ChanSigner>) -> Result<msgs::ChannelUpdate, LightningError> {
1102                 let short_channel_id = match chan.get_short_channel_id() {
1103                         None => return Err(LightningError{err: "Channel not yet established", action: msgs::ErrorAction::IgnoreError}),
1104                         Some(id) => id,
1105                 };
1106
1107                 let were_node_one = PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key).serialize()[..] < chan.get_their_node_id().serialize()[..];
1108
1109                 let unsigned = msgs::UnsignedChannelUpdate {
1110                         chain_hash: self.genesis_hash,
1111                         short_channel_id: short_channel_id,
1112                         timestamp: chan.get_channel_update_count(),
1113                         flags: (!were_node_one) as u16 | ((!chan.is_live() as u16) << 1),
1114                         cltv_expiry_delta: CLTV_EXPIRY_DELTA,
1115                         htlc_minimum_msat: chan.get_our_htlc_minimum_msat(),
1116                         fee_base_msat: chan.get_our_fee_base_msat(&*self.fee_estimator),
1117                         fee_proportional_millionths: chan.get_fee_proportional_millionths(),
1118                         excess_data: Vec::new(),
1119                 };
1120
1121                 let msg_hash = Sha256dHash::hash(&unsigned.encode()[..]);
1122                 let sig = self.secp_ctx.sign(&hash_to_message!(&msg_hash[..]), &self.our_network_key);
1123
1124                 Ok(msgs::ChannelUpdate {
1125                         signature: sig,
1126                         contents: unsigned
1127                 })
1128         }
1129
1130         /// Sends a payment along a given route.
1131         ///
1132         /// Value parameters are provided via the last hop in route, see documentation for RouteHop
1133         /// fields for more info.
1134         ///
1135         /// Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
1136         /// payment), we don't do anything to stop you! We always try to ensure that if the provided
1137         /// next hop knows the preimage to payment_hash they can claim an additional amount as
1138         /// specified in the last hop in the route! Thus, you should probably do your own
1139         /// payment_preimage tracking (which you should already be doing as they represent "proof of
1140         /// payment") and prevent double-sends yourself.
1141         ///
1142         /// May generate a SendHTLCs message event on success, which should be relayed.
1143         ///
1144         /// Raises APIError::RoutError when invalid route or forward parameter
1145         /// (cltv_delta, fee, node public key) is specified.
1146         /// Raises APIError::ChannelUnavailable if the next-hop channel is not available for updates
1147         /// (including due to previous monitor update failure or new permanent monitor update failure).
1148         /// Raised APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
1149         /// relevant updates.
1150         ///
1151         /// In case of APIError::RouteError/APIError::ChannelUnavailable, the payment send has failed
1152         /// and you may wish to retry via a different route immediately.
1153         /// In case of APIError::MonitorUpdateFailed, the commitment update has been irrevocably
1154         /// committed on our end and we're just waiting for a monitor update to send it. Do NOT retry
1155         /// the payment via a different route unless you intend to pay twice!
1156         pub fn send_payment(&self, route: Route, payment_hash: PaymentHash) -> Result<(), APIError> {
1157                 if route.hops.len() < 1 || route.hops.len() > 20 {
1158                         return Err(APIError::RouteError{err: "Route didn't go anywhere/had bogus size"});
1159                 }
1160                 let our_node_id = self.get_our_node_id();
1161                 for (idx, hop) in route.hops.iter().enumerate() {
1162                         if idx != route.hops.len() - 1 && hop.pubkey == our_node_id {
1163                                 return Err(APIError::RouteError{err: "Route went through us but wasn't a simple rebalance loop to us"});
1164                         }
1165                 }
1166
1167                 let (session_priv, prng_seed) = self.keys_manager.get_onion_rand();
1168
1169                 let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
1170
1171                 let onion_keys = secp_call!(onion_utils::construct_onion_keys(&self.secp_ctx, &route, &session_priv),
1172                                 APIError::RouteError{err: "Pubkey along hop was maliciously selected"});
1173                 let (onion_payloads, htlc_msat, htlc_cltv) = onion_utils::build_onion_payloads(&route, cur_height)?;
1174                 if onion_utils::route_size_insane(&onion_payloads) {
1175                         return Err(APIError::RouteError{err: "Route had too large size once"});
1176                 }
1177                 let onion_packet = onion_utils::construct_onion_packet(onion_payloads, onion_keys, prng_seed, &payment_hash);
1178
1179                 let _ = self.total_consistency_lock.read().unwrap();
1180
1181                 let mut channel_lock = self.channel_state.lock().unwrap();
1182                 let err: Result<(), _> = loop {
1183
1184                         let id = match channel_lock.short_to_id.get(&route.hops.first().unwrap().short_channel_id) {
1185                                 None => return Err(APIError::ChannelUnavailable{err: "No channel available with first hop!"}),
1186                                 Some(id) => id.clone(),
1187                         };
1188
1189                         let channel_state = &mut *channel_lock;
1190                         if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(id) {
1191                                 match {
1192                                         if chan.get().get_their_node_id() != route.hops.first().unwrap().pubkey {
1193                                                 return Err(APIError::RouteError{err: "Node ID mismatch on first hop!"});
1194                                         }
1195                                         if !chan.get().is_live() {
1196                                                 return Err(APIError::ChannelUnavailable{err: "Peer for first hop currently disconnected/pending monitor update!"});
1197                                         }
1198                                         break_chan_entry!(self, chan.get_mut().send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, HTLCSource::OutboundRoute {
1199                                                 route: route.clone(),
1200                                                 session_priv: session_priv.clone(),
1201                                                 first_hop_htlc_msat: htlc_msat,
1202                                         }, onion_packet), channel_state, chan)
1203                                 } {
1204                                         Some((update_add, commitment_signed, chan_monitor)) => {
1205                                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1206                                                         maybe_break_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true);
1207                                                         // Note that MonitorUpdateFailed here indicates (per function docs)
1208                                                         // that we will resent the commitment update once we unfree monitor
1209                                                         // updating, so we have to take special care that we don't return
1210                                                         // something else in case we will resend later!
1211                                                         return Err(APIError::MonitorUpdateFailed);
1212                                                 }
1213
1214                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1215                                                         node_id: route.hops.first().unwrap().pubkey,
1216                                                         updates: msgs::CommitmentUpdate {
1217                                                                 update_add_htlcs: vec![update_add],
1218                                                                 update_fulfill_htlcs: Vec::new(),
1219                                                                 update_fail_htlcs: Vec::new(),
1220                                                                 update_fail_malformed_htlcs: Vec::new(),
1221                                                                 update_fee: None,
1222                                                                 commitment_signed,
1223                                                         },
1224                                                 });
1225                                         },
1226                                         None => {},
1227                                 }
1228                         } else { unreachable!(); }
1229                         return Ok(());
1230                 };
1231
1232                 match handle_error!(self, err, route.hops.first().unwrap().pubkey, channel_lock) {
1233                         Ok(_) => unreachable!(),
1234                         Err(e) => { Err(APIError::ChannelUnavailable { err: e.err }) }
1235                 }
1236         }
1237
1238         /// Call this upon creation of a funding transaction for the given channel.
1239         ///
1240         /// Note that ALL inputs in the transaction pointed to by funding_txo MUST spend SegWit outputs
1241         /// or your counterparty can steal your funds!
1242         ///
1243         /// Panics if a funding transaction has already been provided for this channel.
1244         ///
1245         /// May panic if the funding_txo is duplicative with some other channel (note that this should
1246         /// be trivially prevented by using unique funding transaction keys per-channel).
1247         pub fn funding_transaction_generated(&self, temporary_channel_id: &[u8; 32], funding_txo: OutPoint) {
1248                 let _ = self.total_consistency_lock.read().unwrap();
1249
1250                 let (mut chan, msg, chan_monitor) = {
1251                         let mut channel_state = self.channel_state.lock().unwrap();
1252                         let (res, chan) = match channel_state.by_id.remove(temporary_channel_id) {
1253                                 Some(mut chan) => {
1254                                         (chan.get_outbound_funding_created(funding_txo)
1255                                                 .map_err(|e| if let ChannelError::Close(msg) = e {
1256                                                         MsgHandleErrInternal::from_finish_shutdown(msg, chan.channel_id(), chan.force_shutdown(), None)
1257                                                 } else { unreachable!(); })
1258                                         , chan)
1259                                 },
1260                                 None => return
1261                         };
1262                         match handle_error!(self, res, chan.get_their_node_id(), channel_state) {
1263                                 Ok(funding_msg) => {
1264                                         (chan, funding_msg.0, funding_msg.1)
1265                                 },
1266                                 Err(_) => { return; }
1267                         }
1268                 };
1269                 // Because we have exclusive ownership of the channel here we can release the channel_state
1270                 // lock before add_update_monitor
1271                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1272                         match e {
1273                                 ChannelMonitorUpdateErr::PermanentFailure => {
1274                                         {
1275                                                 let mut channel_state = self.channel_state.lock().unwrap();
1276                                                 match handle_error!(self, Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", *temporary_channel_id, chan.force_shutdown(), None)), chan.get_their_node_id(), channel_state) {
1277                                                         Err(_) => { return; },
1278                                                         Ok(()) => unreachable!(),
1279                                                 }
1280                                         }
1281                                 },
1282                                 ChannelMonitorUpdateErr::TemporaryFailure => {
1283                                         // Its completely fine to continue with a FundingCreated until the monitor
1284                                         // update is persisted, as long as we don't generate the FundingBroadcastSafe
1285                                         // until the monitor has been safely persisted (as funding broadcast is not,
1286                                         // in fact, safe).
1287                                         chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1288                                 },
1289                         }
1290                 }
1291
1292                 let mut channel_state = self.channel_state.lock().unwrap();
1293                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingCreated {
1294                         node_id: chan.get_their_node_id(),
1295                         msg: msg,
1296                 });
1297                 match channel_state.by_id.entry(chan.channel_id()) {
1298                         hash_map::Entry::Occupied(_) => {
1299                                 panic!("Generated duplicate funding txid?");
1300                         },
1301                         hash_map::Entry::Vacant(e) => {
1302                                 e.insert(chan);
1303                         }
1304                 }
1305         }
1306
1307         fn get_announcement_sigs(&self, chan: &Channel<ChanSigner>) -> Option<msgs::AnnouncementSignatures> {
1308                 if !chan.should_announce() { return None }
1309
1310                 let (announcement, our_bitcoin_sig) = match chan.get_channel_announcement(self.get_our_node_id(), self.genesis_hash.clone()) {
1311                         Ok(res) => res,
1312                         Err(_) => return None, // Only in case of state precondition violations eg channel is closing
1313                 };
1314                 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1315                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
1316
1317                 Some(msgs::AnnouncementSignatures {
1318                         channel_id: chan.channel_id(),
1319                         short_channel_id: chan.get_short_channel_id().unwrap(),
1320                         node_signature: our_node_sig,
1321                         bitcoin_signature: our_bitcoin_sig,
1322                 })
1323         }
1324
1325         /// Generates a signed node_announcement from the given arguments and creates a
1326         /// BroadcastNodeAnnouncement event.
1327         ///
1328         /// RGB is a node "color" and alias a printable human-readable string to describe this node to
1329         /// humans. They carry no in-protocol meaning.
1330         ///
1331         /// addresses represent the set (possibly empty) of socket addresses on which this node accepts
1332         /// incoming connections.
1333         pub fn broadcast_node_announcement(&self, rgb: [u8; 3], alias: [u8; 32], addresses: msgs::NetAddressSet) {
1334                 let _ = self.total_consistency_lock.read().unwrap();
1335
1336                 let announcement = msgs::UnsignedNodeAnnouncement {
1337                         features: NodeFeatures::supported(),
1338                         timestamp: self.last_node_announcement_serial.fetch_add(1, Ordering::AcqRel) as u32,
1339                         node_id: self.get_our_node_id(),
1340                         rgb, alias,
1341                         addresses: addresses.to_vec(),
1342                         excess_address_data: Vec::new(),
1343                         excess_data: Vec::new(),
1344                 };
1345                 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
1346
1347                 let mut channel_state = self.channel_state.lock().unwrap();
1348                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastNodeAnnouncement {
1349                         msg: msgs::NodeAnnouncement {
1350                                 signature: self.secp_ctx.sign(&msghash, &self.our_network_key),
1351                                 contents: announcement
1352                         },
1353                 });
1354         }
1355
1356         /// Processes HTLCs which are pending waiting on random forward delay.
1357         ///
1358         /// Should only really ever be called in response to a PendingHTLCsForwardable event.
1359         /// Will likely generate further events.
1360         pub fn process_pending_htlc_forwards(&self) {
1361                 let _ = self.total_consistency_lock.read().unwrap();
1362
1363                 let mut new_events = Vec::new();
1364                 let mut failed_forwards = Vec::new();
1365                 let mut handle_errors = Vec::new();
1366                 {
1367                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1368                         let channel_state = &mut *channel_state_lock;
1369
1370                         for (short_chan_id, mut pending_forwards) in channel_state.forward_htlcs.drain() {
1371                                 if short_chan_id != 0 {
1372                                         let forward_chan_id = match channel_state.short_to_id.get(&short_chan_id) {
1373                                                 Some(chan_id) => chan_id.clone(),
1374                                                 None => {
1375                                                         failed_forwards.reserve(pending_forwards.len());
1376                                                         for forward_info in pending_forwards.drain(..) {
1377                                                                 match forward_info {
1378                                                                         HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1379                                                                                 let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1380                                                                                         short_channel_id: prev_short_channel_id,
1381                                                                                         htlc_id: prev_htlc_id,
1382                                                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1383                                                                                 });
1384                                                                                 failed_forwards.push((htlc_source, forward_info.payment_hash, 0x4000 | 10, None));
1385                                                                         },
1386                                                                         HTLCForwardInfo::FailHTLC { .. } => {
1387                                                                                 // Channel went away before we could fail it. This implies
1388                                                                                 // the channel is now on chain and our counterparty is
1389                                                                                 // trying to broadcast the HTLC-Timeout, but that's their
1390                                                                                 // problem, not ours.
1391                                                                         }
1392                                                                 }
1393                                                         }
1394                                                         continue;
1395                                                 }
1396                                         };
1397                                         if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(forward_chan_id) {
1398                                                 let mut add_htlc_msgs = Vec::new();
1399                                                 let mut fail_htlc_msgs = Vec::new();
1400                                                 for forward_info in pending_forwards.drain(..) {
1401                                                         match forward_info {
1402                                                                 HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1403                                                                         log_trace!(self, "Adding HTLC from short id {} with payment_hash {} to channel with short id {} after delay", log_bytes!(forward_info.payment_hash.0), prev_short_channel_id, short_chan_id);
1404                                                                         let htlc_source = HTLCSource::PreviousHopData(HTLCPreviousHopData {
1405                                                                                 short_channel_id: prev_short_channel_id,
1406                                                                                 htlc_id: prev_htlc_id,
1407                                                                                 incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1408                                                                         });
1409                                                                         match chan.get_mut().send_htlc(forward_info.amt_to_forward, forward_info.payment_hash, forward_info.outgoing_cltv_value, htlc_source.clone(), forward_info.onion_packet.unwrap()) {
1410                                                                                 Err(e) => {
1411                                                                                         if let ChannelError::Ignore(msg) = e {
1412                                                                                                 log_trace!(self, "Failed to forward HTLC with payment_hash {}: {}", log_bytes!(forward_info.payment_hash.0), msg);
1413                                                                                         } else {
1414                                                                                                 panic!("Stated return value requirements in send_htlc() were not met");
1415                                                                                         }
1416                                                                                         let chan_update = self.get_channel_update(chan.get()).unwrap();
1417                                                                                         failed_forwards.push((htlc_source, forward_info.payment_hash, 0x1000 | 7, Some(chan_update)));
1418                                                                                         continue;
1419                                                                                 },
1420                                                                                 Ok(update_add) => {
1421                                                                                         match update_add {
1422                                                                                                 Some(msg) => { add_htlc_msgs.push(msg); },
1423                                                                                                 None => {
1424                                                                                                         // Nothing to do here...we're waiting on a remote
1425                                                                                                         // revoke_and_ack before we can add anymore HTLCs. The Channel
1426                                                                                                         // will automatically handle building the update_add_htlc and
1427                                                                                                         // commitment_signed messages when we can.
1428                                                                                                         // TODO: Do some kind of timer to set the channel as !is_live()
1429                                                                                                         // as we don't really want others relying on us relaying through
1430                                                                                                         // this channel currently :/.
1431                                                                                                 }
1432                                                                                         }
1433                                                                                 }
1434                                                                         }
1435                                                                 },
1436                                                                 HTLCForwardInfo::FailHTLC { htlc_id, err_packet } => {
1437                                                                         log_trace!(self, "Failing HTLC back to channel with short id {} after delay", short_chan_id);
1438                                                                         match chan.get_mut().get_update_fail_htlc(htlc_id, err_packet) {
1439                                                                                 Err(e) => {
1440                                                                                         if let ChannelError::Ignore(msg) = e {
1441                                                                                                 log_trace!(self, "Failed to fail backwards to short_id {}: {}", short_chan_id, msg);
1442                                                                                         } else {
1443                                                                                                 panic!("Stated return value requirements in get_update_fail_htlc() were not met");
1444                                                                                         }
1445                                                                                         // fail-backs are best-effort, we probably already have one
1446                                                                                         // pending, and if not that's OK, if not, the channel is on
1447                                                                                         // the chain and sending the HTLC-Timeout is their problem.
1448                                                                                         continue;
1449                                                                                 },
1450                                                                                 Ok(Some(msg)) => { fail_htlc_msgs.push(msg); },
1451                                                                                 Ok(None) => {
1452                                                                                         // Nothing to do here...we're waiting on a remote
1453                                                                                         // revoke_and_ack before we can update the commitment
1454                                                                                         // transaction. The Channel will automatically handle
1455                                                                                         // building the update_fail_htlc and commitment_signed
1456                                                                                         // messages when we can.
1457                                                                                         // We don't need any kind of timer here as they should fail
1458                                                                                         // the channel onto the chain if they can't get our
1459                                                                                         // update_fail_htlc in time, it's not our problem.
1460                                                                                 }
1461                                                                         }
1462                                                                 },
1463                                                         }
1464                                                 }
1465
1466                                                 if !add_htlc_msgs.is_empty() || !fail_htlc_msgs.is_empty() {
1467                                                         let (commitment_msg, monitor) = match chan.get_mut().send_commitment() {
1468                                                                 Ok(res) => res,
1469                                                                 Err(e) => {
1470                                                                         // We surely failed send_commitment due to bad keys, in that case
1471                                                                         // close channel and then send error message to peer.
1472                                                                         let their_node_id = chan.get().get_their_node_id();
1473                                                                         let err: Result<(), _>  = match e {
1474                                                                                 ChannelError::Ignore(_) => {
1475                                                                                         panic!("Stated return value requirements in send_commitment() were not met");
1476                                                                                 },
1477                                                                                 ChannelError::Close(msg) => {
1478                                                                                         log_trace!(self, "Closing channel {} due to Close-required error: {}", log_bytes!(chan.key()[..]), msg);
1479                                                                                         let (channel_id, mut channel) = chan.remove_entry();
1480                                                                                         if let Some(short_id) = channel.get_short_channel_id() {
1481                                                                                                 channel_state.short_to_id.remove(&short_id);
1482                                                                                         }
1483                                                                                         Err(MsgHandleErrInternal::from_finish_shutdown(msg, channel_id, channel.force_shutdown(), self.get_channel_update(&channel).ok()))
1484                                                                                 },
1485                                                                                 ChannelError::CloseDelayBroadcast { .. } => { panic!("Wait is only generated on receipt of channel_reestablish, which is handled by try_chan_entry, we don't bother to support it here"); }
1486                                                                         };
1487                                                                         match handle_error!(self, err, their_node_id, channel_state) {
1488                                                                                 Ok(_) => unreachable!(),
1489                                                                                 Err(_) => { continue; },
1490                                                                         }
1491                                                                 }
1492                                                         };
1493                                                         if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
1494                                                                 handle_errors.push((chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, true)));
1495                                                                 continue;
1496                                                         }
1497                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1498                                                                 node_id: chan.get().get_their_node_id(),
1499                                                                 updates: msgs::CommitmentUpdate {
1500                                                                         update_add_htlcs: add_htlc_msgs,
1501                                                                         update_fulfill_htlcs: Vec::new(),
1502                                                                         update_fail_htlcs: fail_htlc_msgs,
1503                                                                         update_fail_malformed_htlcs: Vec::new(),
1504                                                                         update_fee: None,
1505                                                                         commitment_signed: commitment_msg,
1506                                                                 },
1507                                                         });
1508                                                 }
1509                                         } else {
1510                                                 unreachable!();
1511                                         }
1512                                 } else {
1513                                         for forward_info in pending_forwards.drain(..) {
1514                                                 match forward_info {
1515                                                         HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info } => {
1516                                                                 let prev_hop_data = HTLCPreviousHopData {
1517                                                                         short_channel_id: prev_short_channel_id,
1518                                                                         htlc_id: prev_htlc_id,
1519                                                                         incoming_packet_shared_secret: forward_info.incoming_shared_secret,
1520                                                                 };
1521                                                                 match channel_state.claimable_htlcs.entry(forward_info.payment_hash) {
1522                                                                         hash_map::Entry::Occupied(mut entry) => entry.get_mut().push((forward_info.amt_to_forward, prev_hop_data)),
1523                                                                         hash_map::Entry::Vacant(entry) => { entry.insert(vec![(forward_info.amt_to_forward, prev_hop_data)]); },
1524                                                                 };
1525                                                                 new_events.push(events::Event::PaymentReceived {
1526                                                                         payment_hash: forward_info.payment_hash,
1527                                                                         amt: forward_info.amt_to_forward,
1528                                                                 });
1529                                                         },
1530                                                         HTLCForwardInfo::FailHTLC { .. } => {
1531                                                                 panic!("Got pending fail of our own HTLC");
1532                                                         }
1533                                                 }
1534                                         }
1535                                 }
1536                         }
1537                 }
1538
1539                 for (htlc_source, payment_hash, failure_code, update) in failed_forwards.drain(..) {
1540                         match update {
1541                                 None => self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code, data: Vec::new() }),
1542                                 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() }),
1543                         };
1544                 }
1545
1546                 if handle_errors.len() > 0 {
1547                         let mut channel_state_lock = self.channel_state.lock().unwrap();
1548                         for (their_node_id, err) in handle_errors.drain(..) {
1549                                 let _ = handle_error!(self, err, their_node_id, channel_state_lock);
1550                         }
1551                 }
1552
1553                 if new_events.is_empty() { return }
1554                 let mut events = self.pending_events.lock().unwrap();
1555                 events.append(&mut new_events);
1556         }
1557
1558         /// If a peer is disconnected we mark any channels with that peer as 'disabled'.
1559         /// After some time, if channels are still disabled we need to broadcast a ChannelUpdate
1560         /// to inform the network about the uselessness of these channels.
1561         ///
1562         /// This method handles all the details, and must be called roughly once per minute.
1563         pub fn timer_chan_freshness_every_min(&self) {
1564                 let _ = self.total_consistency_lock.read().unwrap();
1565                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1566                 let channel_state = &mut *channel_state_lock;
1567                 for (_, chan) in channel_state.by_id.iter_mut() {
1568                         if chan.is_disabled_staged() && !chan.is_live() {
1569                                 if let Ok(update) = self.get_channel_update(&chan) {
1570                                         channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1571                                                 msg: update
1572                                         });
1573                                 }
1574                                 chan.to_fresh();
1575                         } else if chan.is_disabled_staged() && chan.is_live() {
1576                                 chan.to_fresh();
1577                         } else if chan.is_disabled_marked() {
1578                                 chan.to_disabled_staged();
1579                         }
1580                 }
1581         }
1582
1583         /// Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
1584         /// after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
1585         /// along the path (including in our own channel on which we received it).
1586         /// Returns false if no payment was found to fail backwards, true if the process of failing the
1587         /// HTLC backwards has been started.
1588         pub fn fail_htlc_backwards(&self, payment_hash: &PaymentHash) -> bool {
1589                 let _ = self.total_consistency_lock.read().unwrap();
1590
1591                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1592                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(payment_hash);
1593                 if let Some(mut sources) = removed_source {
1594                         for (recvd_value, htlc_with_hash) in sources.drain(..) {
1595                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1596                                 self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1597                                                 HTLCSource::PreviousHopData(htlc_with_hash), payment_hash,
1598                                                 HTLCFailReason::Reason { failure_code: 0x4000 | 15, data: byte_utils::be64_to_array(recvd_value).to_vec() });
1599                         }
1600                         true
1601                 } else { false }
1602         }
1603
1604         /// Fails an HTLC backwards to the sender of it to us.
1605         /// Note that while we take a channel_state lock as input, we do *not* assume consistency here.
1606         /// There are several callsites that do stupid things like loop over a list of payment_hashes
1607         /// to fail and take the channel_state lock for each iteration (as we take ownership and may
1608         /// drop it). In other words, no assumptions are made that entries in claimable_htlcs point to
1609         /// still-available channels.
1610         fn fail_htlc_backwards_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<ChanSigner>>, source: HTLCSource, payment_hash: &PaymentHash, onion_error: HTLCFailReason) {
1611                 //TODO: There is a timing attack here where if a node fails an HTLC back to us they can
1612                 //identify whether we sent it or not based on the (I presume) very different runtime
1613                 //between the branches here. We should make this async and move it into the forward HTLCs
1614                 //timer handling.
1615                 match source {
1616                         HTLCSource::OutboundRoute { ref route, .. } => {
1617                                 log_trace!(self, "Failing outbound payment HTLC with payment_hash {}", log_bytes!(payment_hash.0));
1618                                 mem::drop(channel_state_lock);
1619                                 match &onion_error {
1620                                         &HTLCFailReason::LightningError { ref err } => {
1621 #[cfg(test)]
1622                                                 let (channel_update, payment_retryable, onion_error_code) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1623 #[cfg(not(test))]
1624                                                 let (channel_update, payment_retryable, _) = onion_utils::process_onion_failure(&self.secp_ctx, &self.logger, &source, err.data.clone());
1625                                                 // TODO: If we decided to blame ourselves (or one of our channels) in
1626                                                 // process_onion_failure we should close that channel as it implies our
1627                                                 // next-hop is needlessly blaming us!
1628                                                 if let Some(update) = channel_update {
1629                                                         self.channel_state.lock().unwrap().pending_msg_events.push(
1630                                                                 events::MessageSendEvent::PaymentFailureNetworkUpdate {
1631                                                                         update,
1632                                                                 }
1633                                                         );
1634                                                 }
1635                                                 self.pending_events.lock().unwrap().push(
1636                                                         events::Event::PaymentFailed {
1637                                                                 payment_hash: payment_hash.clone(),
1638                                                                 rejected_by_dest: !payment_retryable,
1639 #[cfg(test)]
1640                                                                 error_code: onion_error_code
1641                                                         }
1642                                                 );
1643                                         },
1644                                         &HTLCFailReason::Reason {
1645 #[cfg(test)]
1646                                                         ref failure_code,
1647                                                         .. } => {
1648                                                 // we get a fail_malformed_htlc from the first hop
1649                                                 // TODO: We'd like to generate a PaymentFailureNetworkUpdate for temporary
1650                                                 // failures here, but that would be insufficient as Router::get_route
1651                                                 // generally ignores its view of our own channels as we provide them via
1652                                                 // ChannelDetails.
1653                                                 // TODO: For non-temporary failures, we really should be closing the
1654                                                 // channel here as we apparently can't relay through them anyway.
1655                                                 self.pending_events.lock().unwrap().push(
1656                                                         events::Event::PaymentFailed {
1657                                                                 payment_hash: payment_hash.clone(),
1658                                                                 rejected_by_dest: route.hops.len() == 1,
1659 #[cfg(test)]
1660                                                                 error_code: Some(*failure_code),
1661                                                         }
1662                                                 );
1663                                         }
1664                                 }
1665                         },
1666                         HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, incoming_packet_shared_secret }) => {
1667                                 let err_packet = match onion_error {
1668                                         HTLCFailReason::Reason { failure_code, data } => {
1669                                                 log_trace!(self, "Failing HTLC with payment_hash {} backwards from us with code {}", log_bytes!(payment_hash.0), failure_code);
1670                                                 let packet = onion_utils::build_failure_packet(&incoming_packet_shared_secret, failure_code, &data[..]).encode();
1671                                                 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &packet)
1672                                         },
1673                                         HTLCFailReason::LightningError { err } => {
1674                                                 log_trace!(self, "Failing HTLC with payment_hash {} backwards with pre-built LightningError", log_bytes!(payment_hash.0));
1675                                                 onion_utils::encrypt_failure_packet(&incoming_packet_shared_secret, &err.data)
1676                                         }
1677                                 };
1678
1679                                 let mut forward_event = None;
1680                                 if channel_state_lock.forward_htlcs.is_empty() {
1681                                         forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS));
1682                                 }
1683                                 match channel_state_lock.forward_htlcs.entry(short_channel_id) {
1684                                         hash_map::Entry::Occupied(mut entry) => {
1685                                                 entry.get_mut().push(HTLCForwardInfo::FailHTLC { htlc_id, err_packet });
1686                                         },
1687                                         hash_map::Entry::Vacant(entry) => {
1688                                                 entry.insert(vec!(HTLCForwardInfo::FailHTLC { htlc_id, err_packet }));
1689                                         }
1690                                 }
1691                                 mem::drop(channel_state_lock);
1692                                 if let Some(time) = forward_event {
1693                                         let mut pending_events = self.pending_events.lock().unwrap();
1694                                         pending_events.push(events::Event::PendingHTLCsForwardable {
1695                                                 time_forwardable: time
1696                                         });
1697                                 }
1698                         },
1699                 }
1700         }
1701
1702         /// Provides a payment preimage in response to a PaymentReceived event, returning true and
1703         /// generating message events for the net layer to claim the payment, if possible. Thus, you
1704         /// should probably kick the net layer to go send messages if this returns true!
1705         ///
1706         /// You must specify the expected amounts for this HTLC, and we will only claim HTLCs
1707         /// available within a few percent of the expected amount. This is critical for several
1708         /// reasons : a) it avoids providing senders with `proof-of-payment` (in the form of the
1709         /// payment_preimage without having provided the full value and b) it avoids certain
1710         /// privacy-breaking recipient-probing attacks which may reveal payment activity to
1711         /// motivated attackers.
1712         ///
1713         /// May panic if called except in response to a PaymentReceived event.
1714         pub fn claim_funds(&self, payment_preimage: PaymentPreimage, expected_amount: u64) -> bool {
1715                 let payment_hash = PaymentHash(Sha256::hash(&payment_preimage.0).into_inner());
1716
1717                 let _ = self.total_consistency_lock.read().unwrap();
1718
1719                 let mut channel_state = Some(self.channel_state.lock().unwrap());
1720                 let removed_source = channel_state.as_mut().unwrap().claimable_htlcs.remove(&payment_hash);
1721                 if let Some(mut sources) = removed_source {
1722                         for (received_amount, htlc_with_hash) in sources.drain(..) {
1723                                 if channel_state.is_none() { channel_state = Some(self.channel_state.lock().unwrap()); }
1724                                 if received_amount < expected_amount || received_amount > expected_amount * 2 {
1725                                         let mut htlc_msat_data = byte_utils::be64_to_array(received_amount).to_vec();
1726                                         let mut height_data = byte_utils::be32_to_array(self.latest_block_height.load(Ordering::Acquire) as u32).to_vec();
1727                                         htlc_msat_data.append(&mut height_data);
1728                                         self.fail_htlc_backwards_internal(channel_state.take().unwrap(),
1729                                                                          HTLCSource::PreviousHopData(htlc_with_hash), &payment_hash,
1730                                                                          HTLCFailReason::Reason { failure_code: 0x4000|15, data: htlc_msat_data });
1731                                 } else {
1732                                         self.claim_funds_internal(channel_state.take().unwrap(), HTLCSource::PreviousHopData(htlc_with_hash), payment_preimage);
1733                                 }
1734                         }
1735                         true
1736                 } else { false }
1737         }
1738         fn claim_funds_internal(&self, mut channel_state_lock: MutexGuard<ChannelHolder<ChanSigner>>, source: HTLCSource, payment_preimage: PaymentPreimage) {
1739                 let (their_node_id, err) = loop {
1740                         match source {
1741                                 HTLCSource::OutboundRoute { .. } => {
1742                                         mem::drop(channel_state_lock);
1743                                         let mut pending_events = self.pending_events.lock().unwrap();
1744                                         pending_events.push(events::Event::PaymentSent {
1745                                                 payment_preimage
1746                                         });
1747                                 },
1748                                 HTLCSource::PreviousHopData(HTLCPreviousHopData { short_channel_id, htlc_id, .. }) => {
1749                                         //TODO: Delay the claimed_funds relaying just like we do outbound relay!
1750                                         let channel_state = &mut *channel_state_lock;
1751
1752                                         let chan_id = match channel_state.short_to_id.get(&short_channel_id) {
1753                                                 Some(chan_id) => chan_id.clone(),
1754                                                 None => {
1755                                                         // TODO: There is probably a channel manager somewhere that needs to
1756                                                         // learn the preimage as the channel already hit the chain and that's
1757                                                         // why it's missing.
1758                                                         return
1759                                                 }
1760                                         };
1761
1762                                         if let hash_map::Entry::Occupied(mut chan) = channel_state.by_id.entry(chan_id) {
1763                                                 let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
1764                                                 match chan.get_mut().get_update_fulfill_htlc_and_commit(htlc_id, payment_preimage) {
1765                                                         Ok((msgs, monitor_option)) => {
1766                                                                 if let Some(chan_monitor) = monitor_option {
1767                                                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1768                                                                                 if was_frozen_for_monitor {
1769                                                                                         assert!(msgs.is_none());
1770                                                                                 } else {
1771                                                                                         break (chan.get().get_their_node_id(), handle_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, msgs.is_some()));
1772                                                                                 }
1773                                                                         }
1774                                                                 }
1775                                                                 if let Some((msg, commitment_signed)) = msgs {
1776                                                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1777                                                                                 node_id: chan.get().get_their_node_id(),
1778                                                                                 updates: msgs::CommitmentUpdate {
1779                                                                                         update_add_htlcs: Vec::new(),
1780                                                                                         update_fulfill_htlcs: vec![msg],
1781                                                                                         update_fail_htlcs: Vec::new(),
1782                                                                                         update_fail_malformed_htlcs: Vec::new(),
1783                                                                                         update_fee: None,
1784                                                                                         commitment_signed,
1785                                                                                 }
1786                                                                         });
1787                                                                 }
1788                                                         },
1789                                                         Err(_e) => {
1790                                                                 // TODO: There is probably a channel manager somewhere that needs to
1791                                                                 // learn the preimage as the channel may be about to hit the chain.
1792                                                                 //TODO: Do something with e?
1793                                                                 return
1794                                                         },
1795                                                 }
1796                                         } else { unreachable!(); }
1797                                 },
1798                         }
1799                         return;
1800                 };
1801
1802                 let _ = handle_error!(self, err, their_node_id, channel_state_lock);
1803         }
1804
1805         /// Gets the node_id held by this ChannelManager
1806         pub fn get_our_node_id(&self) -> PublicKey {
1807                 PublicKey::from_secret_key(&self.secp_ctx, &self.our_network_key)
1808         }
1809
1810         /// Used to restore channels to normal operation after a
1811         /// ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
1812         /// operation.
1813         pub fn test_restore_channel_monitor(&self) {
1814                 let mut close_results = Vec::new();
1815                 let mut htlc_forwards = Vec::new();
1816                 let mut htlc_failures = Vec::new();
1817                 let mut pending_events = Vec::new();
1818                 let _ = self.total_consistency_lock.read().unwrap();
1819
1820                 {
1821                         let mut channel_lock = self.channel_state.lock().unwrap();
1822                         let channel_state = &mut *channel_lock;
1823                         let short_to_id = &mut channel_state.short_to_id;
1824                         let pending_msg_events = &mut channel_state.pending_msg_events;
1825                         channel_state.by_id.retain(|_, channel| {
1826                                 if channel.is_awaiting_monitor_update() {
1827                                         let chan_monitor = channel.channel_monitor().clone();
1828                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
1829                                                 match e {
1830                                                         ChannelMonitorUpdateErr::PermanentFailure => {
1831                                                                 // TODO: There may be some pending HTLCs that we intended to fail
1832                                                                 // backwards when a monitor update failed. We should make sure
1833                                                                 // knowledge of those gets moved into the appropriate in-memory
1834                                                                 // ChannelMonitor and they get failed backwards once we get
1835                                                                 // on-chain confirmations.
1836                                                                 // Note I think #198 addresses this, so once it's merged a test
1837                                                                 // should be written.
1838                                                                 if let Some(short_id) = channel.get_short_channel_id() {
1839                                                                         short_to_id.remove(&short_id);
1840                                                                 }
1841                                                                 close_results.push(channel.force_shutdown());
1842                                                                 if let Ok(update) = self.get_channel_update(&channel) {
1843                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
1844                                                                                 msg: update
1845                                                                         });
1846                                                                 }
1847                                                                 false
1848                                                         },
1849                                                         ChannelMonitorUpdateErr::TemporaryFailure => true,
1850                                                 }
1851                                         } else {
1852                                                 let (raa, commitment_update, order, pending_forwards, mut pending_failures, needs_broadcast_safe, funding_locked) = channel.monitor_updating_restored();
1853                                                 if !pending_forwards.is_empty() {
1854                                                         htlc_forwards.push((channel.get_short_channel_id().expect("We can't have pending forwards before funding confirmation"), pending_forwards));
1855                                                 }
1856                                                 htlc_failures.append(&mut pending_failures);
1857
1858                                                 macro_rules! handle_cs { () => {
1859                                                         if let Some(update) = commitment_update {
1860                                                                 pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
1861                                                                         node_id: channel.get_their_node_id(),
1862                                                                         updates: update,
1863                                                                 });
1864                                                         }
1865                                                 } }
1866                                                 macro_rules! handle_raa { () => {
1867                                                         if let Some(revoke_and_ack) = raa {
1868                                                                 pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
1869                                                                         node_id: channel.get_their_node_id(),
1870                                                                         msg: revoke_and_ack,
1871                                                                 });
1872                                                         }
1873                                                 } }
1874                                                 match order {
1875                                                         RAACommitmentOrder::CommitmentFirst => {
1876                                                                 handle_cs!();
1877                                                                 handle_raa!();
1878                                                         },
1879                                                         RAACommitmentOrder::RevokeAndACKFirst => {
1880                                                                 handle_raa!();
1881                                                                 handle_cs!();
1882                                                         },
1883                                                 }
1884                                                 if needs_broadcast_safe {
1885                                                         pending_events.push(events::Event::FundingBroadcastSafe {
1886                                                                 funding_txo: channel.get_funding_txo().unwrap(),
1887                                                                 user_channel_id: channel.get_user_id(),
1888                                                         });
1889                                                 }
1890                                                 if let Some(msg) = funding_locked {
1891                                                         pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
1892                                                                 node_id: channel.get_their_node_id(),
1893                                                                 msg,
1894                                                         });
1895                                                         if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
1896                                                                 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
1897                                                                         node_id: channel.get_their_node_id(),
1898                                                                         msg: announcement_sigs,
1899                                                                 });
1900                                                         }
1901                                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
1902                                                 }
1903                                                 true
1904                                         }
1905                                 } else { true }
1906                         });
1907                 }
1908
1909                 self.pending_events.lock().unwrap().append(&mut pending_events);
1910
1911                 for failure in htlc_failures.drain(..) {
1912                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
1913                 }
1914                 self.forward_htlcs(&mut htlc_forwards[..]);
1915
1916                 for res in close_results.drain(..) {
1917                         self.finish_force_close_channel(res);
1918                 }
1919         }
1920
1921         fn internal_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) -> Result<(), MsgHandleErrInternal> {
1922                 if msg.chain_hash != self.genesis_hash {
1923                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Unknown genesis block hash", msg.temporary_channel_id.clone()));
1924                 }
1925
1926                 let channel = Channel::new_from_req(&*self.fee_estimator, &self.keys_manager, their_node_id.clone(), their_features, msg, 0, Arc::clone(&self.logger), &self.default_configuration)
1927                         .map_err(|e| MsgHandleErrInternal::from_chan_no_close(e, msg.temporary_channel_id))?;
1928                 let mut channel_state_lock = self.channel_state.lock().unwrap();
1929                 let channel_state = &mut *channel_state_lock;
1930                 match channel_state.by_id.entry(channel.channel_id()) {
1931                         hash_map::Entry::Occupied(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("temporary_channel_id collision!", msg.temporary_channel_id.clone())),
1932                         hash_map::Entry::Vacant(entry) => {
1933                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendAcceptChannel {
1934                                         node_id: their_node_id.clone(),
1935                                         msg: channel.get_accept_channel(),
1936                                 });
1937                                 entry.insert(channel);
1938                         }
1939                 }
1940                 Ok(())
1941         }
1942
1943         fn internal_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) -> Result<(), MsgHandleErrInternal> {
1944                 let (value, output_script, user_id) = {
1945                         let mut channel_lock = self.channel_state.lock().unwrap();
1946                         let channel_state = &mut *channel_lock;
1947                         match channel_state.by_id.entry(msg.temporary_channel_id) {
1948                                 hash_map::Entry::Occupied(mut chan) => {
1949                                         if chan.get().get_their_node_id() != *their_node_id {
1950                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1951                                         }
1952                                         try_chan_entry!(self, chan.get_mut().accept_channel(&msg, &self.default_configuration, their_features), channel_state, chan);
1953                                         (chan.get().get_value_satoshis(), chan.get().get_funding_redeemscript().to_v0_p2wsh(), chan.get().get_user_id())
1954                                 },
1955                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1956                         }
1957                 };
1958                 let mut pending_events = self.pending_events.lock().unwrap();
1959                 pending_events.push(events::Event::FundingGenerationReady {
1960                         temporary_channel_id: msg.temporary_channel_id,
1961                         channel_value_satoshis: value,
1962                         output_script: output_script,
1963                         user_channel_id: user_id,
1964                 });
1965                 Ok(())
1966         }
1967
1968         fn internal_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) -> Result<(), MsgHandleErrInternal> {
1969                 let ((funding_msg, monitor_update), mut chan) = {
1970                         let mut channel_lock = self.channel_state.lock().unwrap();
1971                         let channel_state = &mut *channel_lock;
1972                         match channel_state.by_id.entry(msg.temporary_channel_id.clone()) {
1973                                 hash_map::Entry::Occupied(mut chan) => {
1974                                         if chan.get().get_their_node_id() != *their_node_id {
1975                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.temporary_channel_id));
1976                                         }
1977                                         (try_chan_entry!(self, chan.get_mut().funding_created(msg), channel_state, chan), chan.remove())
1978                                 },
1979                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.temporary_channel_id))
1980                         }
1981                 };
1982                 // Because we have exclusive ownership of the channel here we can release the channel_state
1983                 // lock before add_update_monitor
1984                 if let Err(e) = self.monitor.add_update_monitor(monitor_update.get_funding_txo().unwrap(), monitor_update) {
1985                         match e {
1986                                 ChannelMonitorUpdateErr::PermanentFailure => {
1987                                         // Note that we reply with the new channel_id in error messages if we gave up on the
1988                                         // channel, not the temporary_channel_id. This is compatible with ourselves, but the
1989                                         // spec is somewhat ambiguous here. Not a huge deal since we'll send error messages for
1990                                         // any messages referencing a previously-closed channel anyway.
1991                                         return Err(MsgHandleErrInternal::from_finish_shutdown("ChannelMonitor storage failure", funding_msg.channel_id, chan.force_shutdown(), None));
1992                                 },
1993                                 ChannelMonitorUpdateErr::TemporaryFailure => {
1994                                         // There's no problem signing a counterparty's funding transaction if our monitor
1995                                         // hasn't persisted to disk yet - we can't lose money on a transaction that we haven't
1996                                         // accepted payment from yet. We do, however, need to wait to send our funding_locked
1997                                         // until we have persisted our monitor.
1998                                         chan.monitor_update_failed(false, false, Vec::new(), Vec::new());
1999                                 },
2000                         }
2001                 }
2002                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2003                 let channel_state = &mut *channel_state_lock;
2004                 match channel_state.by_id.entry(funding_msg.channel_id) {
2005                         hash_map::Entry::Occupied(_) => {
2006                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Already had channel with the new channel_id", funding_msg.channel_id))
2007                         },
2008                         hash_map::Entry::Vacant(e) => {
2009                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingSigned {
2010                                         node_id: their_node_id.clone(),
2011                                         msg: funding_msg,
2012                                 });
2013                                 e.insert(chan);
2014                         }
2015                 }
2016                 Ok(())
2017         }
2018
2019         fn internal_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) -> Result<(), MsgHandleErrInternal> {
2020                 let (funding_txo, user_id) = {
2021                         let mut channel_lock = self.channel_state.lock().unwrap();
2022                         let channel_state = &mut *channel_lock;
2023                         match channel_state.by_id.entry(msg.channel_id) {
2024                                 hash_map::Entry::Occupied(mut chan) => {
2025                                         if chan.get().get_their_node_id() != *their_node_id {
2026                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2027                                         }
2028                                         let chan_monitor = try_chan_entry!(self, chan.get_mut().funding_signed(&msg), channel_state, chan);
2029                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2030                                                 return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, false, false);
2031                                         }
2032                                         (chan.get().get_funding_txo().unwrap(), chan.get().get_user_id())
2033                                 },
2034                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2035                         }
2036                 };
2037                 let mut pending_events = self.pending_events.lock().unwrap();
2038                 pending_events.push(events::Event::FundingBroadcastSafe {
2039                         funding_txo: funding_txo,
2040                         user_channel_id: user_id,
2041                 });
2042                 Ok(())
2043         }
2044
2045         fn internal_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) -> Result<(), MsgHandleErrInternal> {
2046                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2047                 let channel_state = &mut *channel_state_lock;
2048                 match channel_state.by_id.entry(msg.channel_id) {
2049                         hash_map::Entry::Occupied(mut chan) => {
2050                                 if chan.get().get_their_node_id() != *their_node_id {
2051                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2052                                 }
2053                                 try_chan_entry!(self, chan.get_mut().funding_locked(&msg), channel_state, chan);
2054                                 if let Some(announcement_sigs) = self.get_announcement_sigs(chan.get()) {
2055                                         // If we see locking block before receiving remote funding_locked, we broadcast our
2056                                         // announcement_sigs at remote funding_locked reception. If we receive remote
2057                                         // funding_locked before seeing locking block, we broadcast our announcement_sigs at locking
2058                                         // block connection. We should guanrantee to broadcast announcement_sigs to our peer whatever
2059                                         // the order of the events but our peer may not receive it due to disconnection. The specs
2060                                         // lacking an acknowledgement for announcement_sigs we may have to re-send them at peer
2061                                         // connection in the future if simultaneous misses by both peers due to network/hardware
2062                                         // failures is an issue. Note, to achieve its goal, only one of the announcement_sigs needs
2063                                         // to be received, from then sigs are going to be flood to the whole network.
2064                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2065                                                 node_id: their_node_id.clone(),
2066                                                 msg: announcement_sigs,
2067                                         });
2068                                 }
2069                                 Ok(())
2070                         },
2071                         hash_map::Entry::Vacant(_) => Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2072                 }
2073         }
2074
2075         fn internal_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) -> Result<(), MsgHandleErrInternal> {
2076                 let (mut dropped_htlcs, chan_option) = {
2077                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2078                         let channel_state = &mut *channel_state_lock;
2079
2080                         match channel_state.by_id.entry(msg.channel_id.clone()) {
2081                                 hash_map::Entry::Occupied(mut chan_entry) => {
2082                                         if chan_entry.get().get_their_node_id() != *their_node_id {
2083                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2084                                         }
2085                                         let (shutdown, closing_signed, dropped_htlcs) = try_chan_entry!(self, chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg), channel_state, chan_entry);
2086                                         if let Some(msg) = shutdown {
2087                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2088                                                         node_id: their_node_id.clone(),
2089                                                         msg,
2090                                                 });
2091                                         }
2092                                         if let Some(msg) = closing_signed {
2093                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2094                                                         node_id: their_node_id.clone(),
2095                                                         msg,
2096                                                 });
2097                                         }
2098                                         if chan_entry.get().is_shutdown() {
2099                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2100                                                         channel_state.short_to_id.remove(&short_id);
2101                                                 }
2102                                                 (dropped_htlcs, Some(chan_entry.remove_entry().1))
2103                                         } else { (dropped_htlcs, None) }
2104                                 },
2105                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2106                         }
2107                 };
2108                 for htlc_source in dropped_htlcs.drain(..) {
2109                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source.0, &htlc_source.1, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
2110                 }
2111                 if let Some(chan) = chan_option {
2112                         if let Ok(update) = self.get_channel_update(&chan) {
2113                                 let mut channel_state = self.channel_state.lock().unwrap();
2114                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2115                                         msg: update
2116                                 });
2117                         }
2118                 }
2119                 Ok(())
2120         }
2121
2122         fn internal_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) -> Result<(), MsgHandleErrInternal> {
2123                 let (tx, chan_option) = {
2124                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2125                         let channel_state = &mut *channel_state_lock;
2126                         match channel_state.by_id.entry(msg.channel_id.clone()) {
2127                                 hash_map::Entry::Occupied(mut chan_entry) => {
2128                                         if chan_entry.get().get_their_node_id() != *their_node_id {
2129                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2130                                         }
2131                                         let (closing_signed, tx) = try_chan_entry!(self, chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg), channel_state, chan_entry);
2132                                         if let Some(msg) = closing_signed {
2133                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2134                                                         node_id: their_node_id.clone(),
2135                                                         msg,
2136                                                 });
2137                                         }
2138                                         if tx.is_some() {
2139                                                 // We're done with this channel, we've got a signed closing transaction and
2140                                                 // will send the closing_signed back to the remote peer upon return. This
2141                                                 // also implies there are no pending HTLCs left on the channel, so we can
2142                                                 // fully delete it from tracking (the channel monitor is still around to
2143                                                 // watch for old state broadcasts)!
2144                                                 if let Some(short_id) = chan_entry.get().get_short_channel_id() {
2145                                                         channel_state.short_to_id.remove(&short_id);
2146                                                 }
2147                                                 (tx, Some(chan_entry.remove_entry().1))
2148                                         } else { (tx, None) }
2149                                 },
2150                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2151                         }
2152                 };
2153                 if let Some(broadcast_tx) = tx {
2154                         log_trace!(self, "Broadcast onchain {}", log_tx!(broadcast_tx));
2155                         self.tx_broadcaster.broadcast_transaction(&broadcast_tx);
2156                 }
2157                 if let Some(chan) = chan_option {
2158                         if let Ok(update) = self.get_channel_update(&chan) {
2159                                 let mut channel_state = self.channel_state.lock().unwrap();
2160                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2161                                         msg: update
2162                                 });
2163                         }
2164                 }
2165                 Ok(())
2166         }
2167
2168         fn internal_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) -> Result<(), MsgHandleErrInternal> {
2169                 //TODO: BOLT 4 points out a specific attack where a peer may re-send an onion packet and
2170                 //determine the state of the payment based on our response/if we forward anything/the time
2171                 //we take to respond. We should take care to avoid allowing such an attack.
2172                 //
2173                 //TODO: There exists a further attack where a node may garble the onion data, forward it to
2174                 //us repeatedly garbled in different ways, and compare our error messages, which are
2175                 //encrypted with the same key. It's not immediately obvious how to usefully exploit that,
2176                 //but we should prevent it anyway.
2177
2178                 let (mut pending_forward_info, mut channel_state_lock) = self.decode_update_add_htlc_onion(msg);
2179                 let channel_state = &mut *channel_state_lock;
2180
2181                 match channel_state.by_id.entry(msg.channel_id) {
2182                         hash_map::Entry::Occupied(mut chan) => {
2183                                 if chan.get().get_their_node_id() != *their_node_id {
2184                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2185                                 }
2186                                 if !chan.get().is_usable() {
2187                                         // If the update_add is completely bogus, the call will Err and we will close,
2188                                         // but if we've sent a shutdown and they haven't acknowledged it yet, we just
2189                                         // want to reject the new HTLC and fail it backwards instead of forwarding.
2190                                         if let PendingHTLCStatus::Forward(PendingHTLCInfo { incoming_shared_secret, .. }) = pending_forward_info {
2191                                                 let chan_update = self.get_channel_update(chan.get());
2192                                                 pending_forward_info = PendingHTLCStatus::Fail(HTLCFailureMsg::Relay(msgs::UpdateFailHTLC {
2193                                                         channel_id: msg.channel_id,
2194                                                         htlc_id: msg.htlc_id,
2195                                                         reason: if let Ok(update) = chan_update {
2196                                                                 // TODO: Note that |20 is defined as "channel FROM the processing
2197                                                                 // node has been disabled" (emphasis mine), which seems to imply
2198                                                                 // that we can't return |20 for an inbound channel being disabled.
2199                                                                 // This probably needs a spec update but should definitely be
2200                                                                 // allowed.
2201                                                                 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x1000|20, &{
2202                                                                         let mut res = Vec::with_capacity(8 + 128);
2203                                                                         res.extend_from_slice(&byte_utils::be16_to_array(update.contents.flags));
2204                                                                         res.extend_from_slice(&update.encode_with_len()[..]);
2205                                                                         res
2206                                                                 }[..])
2207                                                         } else {
2208                                                                 // This can only happen if the channel isn't in the fully-funded
2209                                                                 // state yet, implying our counterparty is trying to route payments
2210                                                                 // over the channel back to themselves (cause no one else should
2211                                                                 // know the short_id is a lightning channel yet). We should have no
2212                                                                 // problem just calling this unknown_next_peer
2213                                                                 onion_utils::build_first_hop_failure_packet(&incoming_shared_secret, 0x4000|10, &[])
2214                                                         },
2215                                                 }));
2216                                         }
2217                                 }
2218                                 try_chan_entry!(self, chan.get_mut().update_add_htlc(&msg, pending_forward_info), channel_state, chan);
2219                         },
2220                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2221                 }
2222                 Ok(())
2223         }
2224
2225         fn internal_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) -> Result<(), MsgHandleErrInternal> {
2226                 let mut channel_lock = self.channel_state.lock().unwrap();
2227                 let htlc_source = {
2228                         let channel_state = &mut *channel_lock;
2229                         match channel_state.by_id.entry(msg.channel_id) {
2230                                 hash_map::Entry::Occupied(mut chan) => {
2231                                         if chan.get().get_their_node_id() != *their_node_id {
2232                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2233                                         }
2234                                         try_chan_entry!(self, chan.get_mut().update_fulfill_htlc(&msg), channel_state, chan)
2235                                 },
2236                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2237                         }
2238                 };
2239                 self.claim_funds_internal(channel_lock, htlc_source, msg.payment_preimage.clone());
2240                 Ok(())
2241         }
2242
2243         fn internal_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) -> Result<(), MsgHandleErrInternal> {
2244                 let mut channel_lock = self.channel_state.lock().unwrap();
2245                 let channel_state = &mut *channel_lock;
2246                 match channel_state.by_id.entry(msg.channel_id) {
2247                         hash_map::Entry::Occupied(mut chan) => {
2248                                 if chan.get().get_their_node_id() != *their_node_id {
2249                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2250                                 }
2251                                 try_chan_entry!(self, chan.get_mut().update_fail_htlc(&msg, HTLCFailReason::LightningError { err: msg.reason.clone() }), channel_state, chan);
2252                         },
2253                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2254                 }
2255                 Ok(())
2256         }
2257
2258         fn internal_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) -> Result<(), MsgHandleErrInternal> {
2259                 let mut channel_lock = self.channel_state.lock().unwrap();
2260                 let channel_state = &mut *channel_lock;
2261                 match channel_state.by_id.entry(msg.channel_id) {
2262                         hash_map::Entry::Occupied(mut chan) => {
2263                                 if chan.get().get_their_node_id() != *their_node_id {
2264                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2265                                 }
2266                                 if (msg.failure_code & 0x8000) == 0 {
2267                                         try_chan_entry!(self, Err(ChannelError::Close("Got update_fail_malformed_htlc with BADONION not set")), channel_state, chan);
2268                                 }
2269                                 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);
2270                                 Ok(())
2271                         },
2272                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2273                 }
2274         }
2275
2276         fn internal_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) -> Result<(), MsgHandleErrInternal> {
2277                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2278                 let channel_state = &mut *channel_state_lock;
2279                 match channel_state.by_id.entry(msg.channel_id) {
2280                         hash_map::Entry::Occupied(mut chan) => {
2281                                 if chan.get().get_their_node_id() != *their_node_id {
2282                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2283                                 }
2284                                 let (revoke_and_ack, commitment_signed, closing_signed, chan_monitor) =
2285                                         try_chan_entry!(self, chan.get_mut().commitment_signed(&msg, &*self.fee_estimator), channel_state, chan);
2286                                 if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2287                                         return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::RevokeAndACKFirst, true, commitment_signed.is_some());
2288                                         //TODO: Rebroadcast closing_signed if present on monitor update restoration
2289                                 }
2290                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2291                                         node_id: their_node_id.clone(),
2292                                         msg: revoke_and_ack,
2293                                 });
2294                                 if let Some(msg) = commitment_signed {
2295                                         channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2296                                                 node_id: their_node_id.clone(),
2297                                                 updates: msgs::CommitmentUpdate {
2298                                                         update_add_htlcs: Vec::new(),
2299                                                         update_fulfill_htlcs: Vec::new(),
2300                                                         update_fail_htlcs: Vec::new(),
2301                                                         update_fail_malformed_htlcs: Vec::new(),
2302                                                         update_fee: None,
2303                                                         commitment_signed: msg,
2304                                                 },
2305                                         });
2306                                 }
2307                                 if let Some(msg) = closing_signed {
2308                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2309                                                 node_id: their_node_id.clone(),
2310                                                 msg,
2311                                         });
2312                                 }
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         #[inline]
2320         fn forward_htlcs(&self, per_source_pending_forwards: &mut [(u64, Vec<(PendingHTLCInfo, u64)>)]) {
2321                 for &mut (prev_short_channel_id, ref mut pending_forwards) in per_source_pending_forwards {
2322                         let mut forward_event = None;
2323                         if !pending_forwards.is_empty() {
2324                                 let mut channel_state = self.channel_state.lock().unwrap();
2325                                 if channel_state.forward_htlcs.is_empty() {
2326                                         forward_event = Some(Duration::from_millis(MIN_HTLC_RELAY_HOLDING_CELL_MILLIS))
2327                                 }
2328                                 for (forward_info, prev_htlc_id) in pending_forwards.drain(..) {
2329                                         match channel_state.forward_htlcs.entry(forward_info.short_channel_id) {
2330                                                 hash_map::Entry::Occupied(mut entry) => {
2331                                                         entry.get_mut().push(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info });
2332                                                 },
2333                                                 hash_map::Entry::Vacant(entry) => {
2334                                                         entry.insert(vec!(HTLCForwardInfo::AddHTLC { prev_short_channel_id, prev_htlc_id, forward_info }));
2335                                                 }
2336                                         }
2337                                 }
2338                         }
2339                         match forward_event {
2340                                 Some(time) => {
2341                                         let mut pending_events = self.pending_events.lock().unwrap();
2342                                         pending_events.push(events::Event::PendingHTLCsForwardable {
2343                                                 time_forwardable: time
2344                                         });
2345                                 }
2346                                 None => {},
2347                         }
2348                 }
2349         }
2350
2351         fn internal_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) -> Result<(), MsgHandleErrInternal> {
2352                 let (pending_forwards, mut pending_failures, short_channel_id) = {
2353                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2354                         let channel_state = &mut *channel_state_lock;
2355                         match channel_state.by_id.entry(msg.channel_id) {
2356                                 hash_map::Entry::Occupied(mut chan) => {
2357                                         if chan.get().get_their_node_id() != *their_node_id {
2358                                                 return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2359                                         }
2360                                         let was_frozen_for_monitor = chan.get().is_awaiting_monitor_update();
2361                                         let (commitment_update, pending_forwards, pending_failures, closing_signed, chan_monitor) =
2362                                                 try_chan_entry!(self, chan.get_mut().revoke_and_ack(&msg, &*self.fee_estimator), channel_state, chan);
2363                                         if let Err(e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2364                                                 if was_frozen_for_monitor {
2365                                                         assert!(commitment_update.is_none() && closing_signed.is_none() && pending_forwards.is_empty() && pending_failures.is_empty());
2366                                                         return Err(MsgHandleErrInternal::ignore_no_close("Previous monitor update failure prevented responses to RAA"));
2367                                                 } else {
2368                                                         return_monitor_err!(self, e, channel_state, chan, RAACommitmentOrder::CommitmentFirst, false, commitment_update.is_some(), pending_forwards, pending_failures);
2369                                                 }
2370                                         }
2371                                         if let Some(updates) = commitment_update {
2372                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2373                                                         node_id: their_node_id.clone(),
2374                                                         updates,
2375                                                 });
2376                                         }
2377                                         if let Some(msg) = closing_signed {
2378                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendClosingSigned {
2379                                                         node_id: their_node_id.clone(),
2380                                                         msg,
2381                                                 });
2382                                         }
2383                                         (pending_forwards, pending_failures, chan.get().get_short_channel_id().expect("RAA should only work on a short-id-available channel"))
2384                                 },
2385                                 hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2386                         }
2387                 };
2388                 for failure in pending_failures.drain(..) {
2389                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), failure.0, &failure.1, failure.2);
2390                 }
2391                 self.forward_htlcs(&mut [(short_channel_id, pending_forwards)]);
2392
2393                 Ok(())
2394         }
2395
2396         fn internal_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) -> Result<(), MsgHandleErrInternal> {
2397                 let mut channel_lock = self.channel_state.lock().unwrap();
2398                 let channel_state = &mut *channel_lock;
2399                 match channel_state.by_id.entry(msg.channel_id) {
2400                         hash_map::Entry::Occupied(mut chan) => {
2401                                 if chan.get().get_their_node_id() != *their_node_id {
2402                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2403                                 }
2404                                 try_chan_entry!(self, chan.get_mut().update_fee(&*self.fee_estimator, &msg), channel_state, chan);
2405                         },
2406                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2407                 }
2408                 Ok(())
2409         }
2410
2411         fn internal_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) -> Result<(), MsgHandleErrInternal> {
2412                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2413                 let channel_state = &mut *channel_state_lock;
2414
2415                 match channel_state.by_id.entry(msg.channel_id) {
2416                         hash_map::Entry::Occupied(mut chan) => {
2417                                 if chan.get().get_their_node_id() != *their_node_id {
2418                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2419                                 }
2420                                 if !chan.get().is_usable() {
2421                                         return Err(MsgHandleErrInternal::from_no_close(LightningError{err: "Got an announcement_signatures before we were ready for it", action: msgs::ErrorAction::IgnoreError}));
2422                                 }
2423
2424                                 let our_node_id = self.get_our_node_id();
2425                                 let (announcement, our_bitcoin_sig) =
2426                                         try_chan_entry!(self, chan.get_mut().get_channel_announcement(our_node_id.clone(), self.genesis_hash.clone()), channel_state, chan);
2427
2428                                 let were_node_one = announcement.node_id_1 == our_node_id;
2429                                 let msghash = hash_to_message!(&Sha256dHash::hash(&announcement.encode()[..])[..]);
2430                                 if self.secp_ctx.verify(&msghash, &msg.node_signature, if were_node_one { &announcement.node_id_2 } else { &announcement.node_id_1 }).is_err() ||
2431                                                 self.secp_ctx.verify(&msghash, &msg.bitcoin_signature, if were_node_one { &announcement.bitcoin_key_2 } else { &announcement.bitcoin_key_1 }).is_err() {
2432                                         try_chan_entry!(self, Err(ChannelError::Close("Bad announcement_signatures node_signature")), channel_state, chan);
2433                                 }
2434
2435                                 let our_node_sig = self.secp_ctx.sign(&msghash, &self.our_network_key);
2436
2437                                 channel_state.pending_msg_events.push(events::MessageSendEvent::BroadcastChannelAnnouncement {
2438                                         msg: msgs::ChannelAnnouncement {
2439                                                 node_signature_1: if were_node_one { our_node_sig } else { msg.node_signature },
2440                                                 node_signature_2: if were_node_one { msg.node_signature } else { our_node_sig },
2441                                                 bitcoin_signature_1: if were_node_one { our_bitcoin_sig } else { msg.bitcoin_signature },
2442                                                 bitcoin_signature_2: if were_node_one { msg.bitcoin_signature } else { our_bitcoin_sig },
2443                                                 contents: announcement,
2444                                         },
2445                                         update_msg: self.get_channel_update(chan.get()).unwrap(), // can only fail if we're not in a ready state
2446                                 });
2447                         },
2448                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2449                 }
2450                 Ok(())
2451         }
2452
2453         fn internal_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) -> Result<(), MsgHandleErrInternal> {
2454                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2455                 let channel_state = &mut *channel_state_lock;
2456
2457                 match channel_state.by_id.entry(msg.channel_id) {
2458                         hash_map::Entry::Occupied(mut chan) => {
2459                                 if chan.get().get_their_node_id() != *their_node_id {
2460                                         return Err(MsgHandleErrInternal::send_err_msg_no_close("Got a message for a channel from the wrong node!", msg.channel_id));
2461                                 }
2462                                 let (funding_locked, revoke_and_ack, commitment_update, channel_monitor, mut order, shutdown) =
2463                                         try_chan_entry!(self, chan.get_mut().channel_reestablish(msg), channel_state, chan);
2464                                 if let Some(monitor) = channel_monitor {
2465                                         if let Err(e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) {
2466                                                 // channel_reestablish doesn't guarantee the order it returns is sensical
2467                                                 // for the messages it returns, but if we're setting what messages to
2468                                                 // re-transmit on monitor update success, we need to make sure it is sane.
2469                                                 if revoke_and_ack.is_none() {
2470                                                         order = RAACommitmentOrder::CommitmentFirst;
2471                                                 }
2472                                                 if commitment_update.is_none() {
2473                                                         order = RAACommitmentOrder::RevokeAndACKFirst;
2474                                                 }
2475                                                 return_monitor_err!(self, e, channel_state, chan, order, revoke_and_ack.is_some(), commitment_update.is_some());
2476                                                 //TODO: Resend the funding_locked if needed once we get the monitor running again
2477                                         }
2478                                 }
2479                                 if let Some(msg) = funding_locked {
2480                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2481                                                 node_id: their_node_id.clone(),
2482                                                 msg
2483                                         });
2484                                 }
2485                                 macro_rules! send_raa { () => {
2486                                         if let Some(msg) = revoke_and_ack {
2487                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::SendRevokeAndACK {
2488                                                         node_id: their_node_id.clone(),
2489                                                         msg
2490                                                 });
2491                                         }
2492                                 } }
2493                                 macro_rules! send_cu { () => {
2494                                         if let Some(updates) = commitment_update {
2495                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2496                                                         node_id: their_node_id.clone(),
2497                                                         updates
2498                                                 });
2499                                         }
2500                                 } }
2501                                 match order {
2502                                         RAACommitmentOrder::RevokeAndACKFirst => {
2503                                                 send_raa!();
2504                                                 send_cu!();
2505                                         },
2506                                         RAACommitmentOrder::CommitmentFirst => {
2507                                                 send_cu!();
2508                                                 send_raa!();
2509                                         },
2510                                 }
2511                                 if let Some(msg) = shutdown {
2512                                         channel_state.pending_msg_events.push(events::MessageSendEvent::SendShutdown {
2513                                                 node_id: their_node_id.clone(),
2514                                                 msg,
2515                                         });
2516                                 }
2517                                 Ok(())
2518                         },
2519                         hash_map::Entry::Vacant(_) => return Err(MsgHandleErrInternal::send_err_msg_no_close("Failed to find corresponding channel", msg.channel_id))
2520                 }
2521         }
2522
2523         /// Begin Update fee process. Allowed only on an outbound channel.
2524         /// If successful, will generate a UpdateHTLCs event, so you should probably poll
2525         /// PeerManager::process_events afterwards.
2526         /// Note: This API is likely to change!
2527         #[doc(hidden)]
2528         pub fn update_fee(&self, channel_id: [u8;32], feerate_per_kw: u64) -> Result<(), APIError> {
2529                 let _ = self.total_consistency_lock.read().unwrap();
2530                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2531                 let their_node_id;
2532                 let err: Result<(), _> = loop {
2533                         let channel_state = &mut *channel_state_lock;
2534
2535                         match channel_state.by_id.entry(channel_id) {
2536                                 hash_map::Entry::Vacant(_) => return Err(APIError::APIMisuseError{err: "Failed to find corresponding channel"}),
2537                                 hash_map::Entry::Occupied(mut chan) => {
2538                                         if !chan.get().is_outbound() {
2539                                                 return Err(APIError::APIMisuseError{err: "update_fee cannot be sent for an inbound channel"});
2540                                         }
2541                                         if chan.get().is_awaiting_monitor_update() {
2542                                                 return Err(APIError::MonitorUpdateFailed);
2543                                         }
2544                                         if !chan.get().is_live() {
2545                                                 return Err(APIError::ChannelUnavailable{err: "Channel is either not yet fully established or peer is currently disconnected"});
2546                                         }
2547                                         their_node_id = chan.get().get_their_node_id();
2548                                         if let Some((update_fee, commitment_signed, chan_monitor)) =
2549                                                         break_chan_entry!(self, chan.get_mut().send_update_fee_and_commit(feerate_per_kw), channel_state, chan)
2550                                         {
2551                                                 if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) {
2552                                                         unimplemented!();
2553                                                 }
2554                                                 channel_state.pending_msg_events.push(events::MessageSendEvent::UpdateHTLCs {
2555                                                         node_id: chan.get().get_their_node_id(),
2556                                                         updates: msgs::CommitmentUpdate {
2557                                                                 update_add_htlcs: Vec::new(),
2558                                                                 update_fulfill_htlcs: Vec::new(),
2559                                                                 update_fail_htlcs: Vec::new(),
2560                                                                 update_fail_malformed_htlcs: Vec::new(),
2561                                                                 update_fee: Some(update_fee),
2562                                                                 commitment_signed,
2563                                                         },
2564                                                 });
2565                                         }
2566                                 },
2567                         }
2568                         return Ok(())
2569                 };
2570
2571                 match handle_error!(self, err, their_node_id, channel_state_lock) {
2572                         Ok(_) => unreachable!(),
2573                         Err(e) => { Err(APIError::APIMisuseError { err: e.err })}
2574                 }
2575         }
2576 }
2577
2578 impl<ChanSigner: ChannelKeys, M: Deref> events::MessageSendEventsProvider for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor {
2579         fn get_and_clear_pending_msg_events(&self) -> Vec<events::MessageSendEvent> {
2580                 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2581                 // user to serialize a ChannelManager with pending events in it and lose those events on
2582                 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2583                 {
2584                         //TODO: This behavior should be documented.
2585                         for htlc_update in self.monitor.fetch_pending_htlc_updated() {
2586                                 if let Some(preimage) = htlc_update.payment_preimage {
2587                                         log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2588                                         self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2589                                 } else {
2590                                         log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2591                                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_update.source, &htlc_update.payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
2592                                 }
2593                         }
2594                 }
2595
2596                 let mut ret = Vec::new();
2597                 let mut channel_state = self.channel_state.lock().unwrap();
2598                 mem::swap(&mut ret, &mut channel_state.pending_msg_events);
2599                 ret
2600         }
2601 }
2602
2603 impl<ChanSigner: ChannelKeys, M: Deref> events::EventsProvider for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor {
2604         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
2605                 // TODO: Event release to users and serialization is currently race-y: it's very easy for a
2606                 // user to serialize a ChannelManager with pending events in it and lose those events on
2607                 // restart. This is doubly true for the fail/fulfill-backs from monitor events!
2608                 {
2609                         //TODO: This behavior should be documented.
2610                         for htlc_update in self.monitor.fetch_pending_htlc_updated() {
2611                                 if let Some(preimage) = htlc_update.payment_preimage {
2612                                         log_trace!(self, "Claiming HTLC with preimage {} from our monitor", log_bytes!(preimage.0));
2613                                         self.claim_funds_internal(self.channel_state.lock().unwrap(), htlc_update.source, preimage);
2614                                 } else {
2615                                         log_trace!(self, "Failing HTLC with hash {} from our monitor", log_bytes!(htlc_update.payment_hash.0));
2616                                         self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_update.source, &htlc_update.payment_hash, HTLCFailReason::Reason { failure_code: 0x4000 | 8, data: Vec::new() });
2617                                 }
2618                         }
2619                 }
2620
2621                 let mut ret = Vec::new();
2622                 let mut pending_events = self.pending_events.lock().unwrap();
2623                 mem::swap(&mut ret, &mut *pending_events);
2624                 ret
2625         }
2626 }
2627
2628 impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send> ChainListener for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor {
2629         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], indexes_of_txn_matched: &[u32]) {
2630                 let header_hash = header.bitcoin_hash();
2631                 log_trace!(self, "Block {} at height {} connected with {} txn matched", header_hash, height, txn_matched.len());
2632                 let _ = self.total_consistency_lock.read().unwrap();
2633                 let mut failed_channels = Vec::new();
2634                 {
2635                         let mut channel_lock = self.channel_state.lock().unwrap();
2636                         let channel_state = &mut *channel_lock;
2637                         let short_to_id = &mut channel_state.short_to_id;
2638                         let pending_msg_events = &mut channel_state.pending_msg_events;
2639                         channel_state.by_id.retain(|_, channel| {
2640                                 let chan_res = channel.block_connected(header, height, txn_matched, indexes_of_txn_matched);
2641                                 if let Ok(Some(funding_locked)) = chan_res {
2642                                         pending_msg_events.push(events::MessageSendEvent::SendFundingLocked {
2643                                                 node_id: channel.get_their_node_id(),
2644                                                 msg: funding_locked,
2645                                         });
2646                                         if let Some(announcement_sigs) = self.get_announcement_sigs(channel) {
2647                                                 pending_msg_events.push(events::MessageSendEvent::SendAnnouncementSignatures {
2648                                                         node_id: channel.get_their_node_id(),
2649                                                         msg: announcement_sigs,
2650                                                 });
2651                                         }
2652                                         short_to_id.insert(channel.get_short_channel_id().unwrap(), channel.channel_id());
2653                                 } else if let Err(e) = chan_res {
2654                                         pending_msg_events.push(events::MessageSendEvent::HandleError {
2655                                                 node_id: channel.get_their_node_id(),
2656                                                 action: msgs::ErrorAction::SendErrorMessage { msg: e },
2657                                         });
2658                                         return false;
2659                                 }
2660                                 if let Some(funding_txo) = channel.get_funding_txo() {
2661                                         for tx in txn_matched {
2662                                                 for inp in tx.input.iter() {
2663                                                         if inp.previous_output == funding_txo.into_bitcoin_outpoint() {
2664                                                                 log_trace!(self, "Detected channel-closing tx {} spending {}:{}, closing channel {}", tx.txid(), inp.previous_output.txid, inp.previous_output.vout, log_bytes!(channel.channel_id()));
2665                                                                 if let Some(short_id) = channel.get_short_channel_id() {
2666                                                                         short_to_id.remove(&short_id);
2667                                                                 }
2668                                                                 // It looks like our counterparty went on-chain. We go ahead and
2669                                                                 // broadcast our latest local state as well here, just in case its
2670                                                                 // some kind of SPV attack, though we expect these to be dropped.
2671                                                                 failed_channels.push(channel.force_shutdown());
2672                                                                 if let Ok(update) = self.get_channel_update(&channel) {
2673                                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2674                                                                                 msg: update
2675                                                                         });
2676                                                                 }
2677                                                                 return false;
2678                                                         }
2679                                                 }
2680                                         }
2681                                 }
2682                                 if channel.is_funding_initiated() && channel.channel_monitor().would_broadcast_at_height(height) {
2683                                         if let Some(short_id) = channel.get_short_channel_id() {
2684                                                 short_to_id.remove(&short_id);
2685                                         }
2686                                         failed_channels.push(channel.force_shutdown());
2687                                         // If would_broadcast_at_height() is true, the channel_monitor will broadcast
2688                                         // the latest local tx for us, so we should skip that here (it doesn't really
2689                                         // hurt anything, but does make tests a bit simpler).
2690                                         failed_channels.last_mut().unwrap().0 = Vec::new();
2691                                         if let Ok(update) = self.get_channel_update(&channel) {
2692                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2693                                                         msg: update
2694                                                 });
2695                                         }
2696                                         return false;
2697                                 }
2698                                 true
2699                         });
2700                 }
2701                 for failure in failed_channels.drain(..) {
2702                         self.finish_force_close_channel(failure);
2703                 }
2704                 self.latest_block_height.store(height as usize, Ordering::Release);
2705                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header_hash;
2706         }
2707
2708         /// We force-close the channel without letting our counterparty participate in the shutdown
2709         fn block_disconnected(&self, header: &BlockHeader, _: u32) {
2710                 let _ = self.total_consistency_lock.read().unwrap();
2711                 let mut failed_channels = Vec::new();
2712                 {
2713                         let mut channel_lock = self.channel_state.lock().unwrap();
2714                         let channel_state = &mut *channel_lock;
2715                         let short_to_id = &mut channel_state.short_to_id;
2716                         let pending_msg_events = &mut channel_state.pending_msg_events;
2717                         channel_state.by_id.retain(|_,  v| {
2718                                 if v.block_disconnected(header) {
2719                                         if let Some(short_id) = v.get_short_channel_id() {
2720                                                 short_to_id.remove(&short_id);
2721                                         }
2722                                         failed_channels.push(v.force_shutdown());
2723                                         if let Ok(update) = self.get_channel_update(&v) {
2724                                                 pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2725                                                         msg: update
2726                                                 });
2727                                         }
2728                                         false
2729                                 } else {
2730                                         true
2731                                 }
2732                         });
2733                 }
2734                 for failure in failed_channels.drain(..) {
2735                         self.finish_force_close_channel(failure);
2736                 }
2737                 self.latest_block_height.fetch_sub(1, Ordering::AcqRel);
2738                 *self.last_block_hash.try_lock().expect("block_(dis)connected must not be called in parallel") = header.bitcoin_hash();
2739         }
2740 }
2741
2742 impl<ChanSigner: ChannelKeys, M: Deref + Sync + Send> ChannelMessageHandler for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor {
2743         fn handle_open_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::OpenChannel) {
2744                 let _ = self.total_consistency_lock.read().unwrap();
2745                 let res = self.internal_open_channel(their_node_id, their_features, msg);
2746                 if res.is_err() {
2747                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2748                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2749                 }
2750         }
2751
2752         fn handle_accept_channel(&self, their_node_id: &PublicKey, their_features: InitFeatures, msg: &msgs::AcceptChannel) {
2753                 let _ = self.total_consistency_lock.read().unwrap();
2754                 let res = self.internal_accept_channel(their_node_id, their_features, msg);
2755                 if res.is_err() {
2756                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2757                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2758                 }
2759         }
2760
2761         fn handle_funding_created(&self, their_node_id: &PublicKey, msg: &msgs::FundingCreated) {
2762                 let _ = self.total_consistency_lock.read().unwrap();
2763                 let res = self.internal_funding_created(their_node_id, msg);
2764                 if res.is_err() {
2765                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2766                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2767                 }
2768         }
2769
2770         fn handle_funding_signed(&self, their_node_id: &PublicKey, msg: &msgs::FundingSigned) {
2771                 let _ = self.total_consistency_lock.read().unwrap();
2772                 let res = self.internal_funding_signed(their_node_id, msg);
2773                 if res.is_err() {
2774                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2775                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2776                 }
2777         }
2778
2779         fn handle_funding_locked(&self, their_node_id: &PublicKey, msg: &msgs::FundingLocked) {
2780                 let _ = self.total_consistency_lock.read().unwrap();
2781                 let res = self.internal_funding_locked(their_node_id, msg);
2782                 if res.is_err() {
2783                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2784                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2785                 }
2786         }
2787
2788         fn handle_shutdown(&self, their_node_id: &PublicKey, msg: &msgs::Shutdown) {
2789                 let _ = self.total_consistency_lock.read().unwrap();
2790                 let res = self.internal_shutdown(their_node_id, msg);
2791                 if res.is_err() {
2792                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2793                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2794                 }
2795         }
2796
2797         fn handle_closing_signed(&self, their_node_id: &PublicKey, msg: &msgs::ClosingSigned) {
2798                 let _ = self.total_consistency_lock.read().unwrap();
2799                 let res = self.internal_closing_signed(their_node_id, msg);
2800                 if res.is_err() {
2801                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2802                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2803                 }
2804         }
2805
2806         fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateAddHTLC) {
2807                 let _ = self.total_consistency_lock.read().unwrap();
2808                 let res = self.internal_update_add_htlc(their_node_id, msg);
2809                 if res.is_err() {
2810                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2811                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2812                 }
2813         }
2814
2815         fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFulfillHTLC) {
2816                 let _ = self.total_consistency_lock.read().unwrap();
2817                 let res = self.internal_update_fulfill_htlc(their_node_id, msg);
2818                 if res.is_err() {
2819                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2820                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2821                 }
2822         }
2823
2824         fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailHTLC) {
2825                 let _ = self.total_consistency_lock.read().unwrap();
2826                 let res = self.internal_update_fail_htlc(their_node_id, msg);
2827                 if res.is_err() {
2828                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2829                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2830                 }
2831         }
2832
2833         fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFailMalformedHTLC) {
2834                 let _ = self.total_consistency_lock.read().unwrap();
2835                 let res = self.internal_update_fail_malformed_htlc(their_node_id, msg);
2836                 if res.is_err() {
2837                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2838                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2839                 }
2840         }
2841
2842         fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &msgs::CommitmentSigned) {
2843                 let _ = self.total_consistency_lock.read().unwrap();
2844                 let res = self.internal_commitment_signed(their_node_id, msg);
2845                 if res.is_err() {
2846                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2847                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2848                 }
2849         }
2850
2851         fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &msgs::RevokeAndACK) {
2852                 let _ = self.total_consistency_lock.read().unwrap();
2853                 let res = self.internal_revoke_and_ack(their_node_id, msg);
2854                 if res.is_err() {
2855                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2856                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2857                 }
2858         }
2859
2860         fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &msgs::UpdateFee) {
2861                 let _ = self.total_consistency_lock.read().unwrap();
2862                 let res = self.internal_update_fee(their_node_id, msg);
2863                 if res.is_err() {
2864                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2865                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2866                 }
2867         }
2868
2869         fn handle_announcement_signatures(&self, their_node_id: &PublicKey, msg: &msgs::AnnouncementSignatures) {
2870                 let _ = self.total_consistency_lock.read().unwrap();
2871                 let res = self.internal_announcement_signatures(their_node_id, msg);
2872                 if res.is_err() {
2873                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2874                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2875                 }
2876         }
2877
2878         fn handle_channel_reestablish(&self, their_node_id: &PublicKey, msg: &msgs::ChannelReestablish) {
2879                 let _ = self.total_consistency_lock.read().unwrap();
2880                 let res = self.internal_channel_reestablish(their_node_id, msg);
2881                 if res.is_err() {
2882                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2883                         let _ = handle_error!(self, res, *their_node_id, channel_state_lock);
2884                 }
2885         }
2886
2887         fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool) {
2888                 let _ = self.total_consistency_lock.read().unwrap();
2889                 let mut failed_channels = Vec::new();
2890                 let mut failed_payments = Vec::new();
2891                 let mut no_channels_remain = true;
2892                 {
2893                         let mut channel_state_lock = self.channel_state.lock().unwrap();
2894                         let channel_state = &mut *channel_state_lock;
2895                         let short_to_id = &mut channel_state.short_to_id;
2896                         let pending_msg_events = &mut channel_state.pending_msg_events;
2897                         if no_connection_possible {
2898                                 log_debug!(self, "Failing all channels with {} due to no_connection_possible", log_pubkey!(their_node_id));
2899                                 channel_state.by_id.retain(|_, chan| {
2900                                         if chan.get_their_node_id() == *their_node_id {
2901                                                 if let Some(short_id) = chan.get_short_channel_id() {
2902                                                         short_to_id.remove(&short_id);
2903                                                 }
2904                                                 failed_channels.push(chan.force_shutdown());
2905                                                 if let Ok(update) = self.get_channel_update(&chan) {
2906                                                         pending_msg_events.push(events::MessageSendEvent::BroadcastChannelUpdate {
2907                                                                 msg: update
2908                                                         });
2909                                                 }
2910                                                 false
2911                                         } else {
2912                                                 true
2913                                         }
2914                                 });
2915                         } else {
2916                                 log_debug!(self, "Marking channels with {} disconnected and generating channel_updates", log_pubkey!(their_node_id));
2917                                 channel_state.by_id.retain(|_, chan| {
2918                                         if chan.get_their_node_id() == *their_node_id {
2919                                                 let failed_adds = chan.remove_uncommitted_htlcs_and_mark_paused();
2920                                                 chan.to_disabled_marked();
2921                                                 if !failed_adds.is_empty() {
2922                                                         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
2923                                                         failed_payments.push((chan_update, failed_adds));
2924                                                 }
2925                                                 if chan.is_shutdown() {
2926                                                         if let Some(short_id) = chan.get_short_channel_id() {
2927                                                                 short_to_id.remove(&short_id);
2928                                                         }
2929                                                         return false;
2930                                                 } else {
2931                                                         no_channels_remain = false;
2932                                                 }
2933                                         }
2934                                         true
2935                                 })
2936                         }
2937                         pending_msg_events.retain(|msg| {
2938                                 match msg {
2939                                         &events::MessageSendEvent::SendAcceptChannel { ref node_id, .. } => node_id != their_node_id,
2940                                         &events::MessageSendEvent::SendOpenChannel { ref node_id, .. } => node_id != their_node_id,
2941                                         &events::MessageSendEvent::SendFundingCreated { ref node_id, .. } => node_id != their_node_id,
2942                                         &events::MessageSendEvent::SendFundingSigned { ref node_id, .. } => node_id != their_node_id,
2943                                         &events::MessageSendEvent::SendFundingLocked { ref node_id, .. } => node_id != their_node_id,
2944                                         &events::MessageSendEvent::SendAnnouncementSignatures { ref node_id, .. } => node_id != their_node_id,
2945                                         &events::MessageSendEvent::UpdateHTLCs { ref node_id, .. } => node_id != their_node_id,
2946                                         &events::MessageSendEvent::SendRevokeAndACK { ref node_id, .. } => node_id != their_node_id,
2947                                         &events::MessageSendEvent::SendClosingSigned { ref node_id, .. } => node_id != their_node_id,
2948                                         &events::MessageSendEvent::SendShutdown { ref node_id, .. } => node_id != their_node_id,
2949                                         &events::MessageSendEvent::SendChannelReestablish { ref node_id, .. } => node_id != their_node_id,
2950                                         &events::MessageSendEvent::BroadcastChannelAnnouncement { .. } => true,
2951                                         &events::MessageSendEvent::BroadcastNodeAnnouncement { .. } => true,
2952                                         &events::MessageSendEvent::BroadcastChannelUpdate { .. } => true,
2953                                         &events::MessageSendEvent::HandleError { ref node_id, .. } => node_id != their_node_id,
2954                                         &events::MessageSendEvent::PaymentFailureNetworkUpdate { .. } => true,
2955                                 }
2956                         });
2957                 }
2958                 if no_channels_remain {
2959                         self.per_peer_state.write().unwrap().remove(their_node_id);
2960                 }
2961
2962                 for failure in failed_channels.drain(..) {
2963                         self.finish_force_close_channel(failure);
2964                 }
2965                 for (chan_update, mut htlc_sources) in failed_payments {
2966                         for (htlc_source, payment_hash) in htlc_sources.drain(..) {
2967                                 self.fail_htlc_backwards_internal(self.channel_state.lock().unwrap(), htlc_source, &payment_hash, HTLCFailReason::Reason { failure_code: 0x1000 | 7, data: chan_update.clone() });
2968                         }
2969                 }
2970         }
2971
2972         fn peer_connected(&self, their_node_id: &PublicKey, init_msg: &msgs::Init) {
2973                 log_debug!(self, "Generating channel_reestablish events for {}", log_pubkey!(their_node_id));
2974
2975                 let _ = self.total_consistency_lock.read().unwrap();
2976
2977                 {
2978                         let mut peer_state_lock = self.per_peer_state.write().unwrap();
2979                         match peer_state_lock.entry(their_node_id.clone()) {
2980                                 hash_map::Entry::Vacant(e) => {
2981                                         e.insert(Mutex::new(PeerState {
2982                                                 latest_features: init_msg.features.clone(),
2983                                         }));
2984                                 },
2985                                 hash_map::Entry::Occupied(e) => {
2986                                         e.get().lock().unwrap().latest_features = init_msg.features.clone();
2987                                 },
2988                         }
2989                 }
2990
2991                 let mut channel_state_lock = self.channel_state.lock().unwrap();
2992                 let channel_state = &mut *channel_state_lock;
2993                 let pending_msg_events = &mut channel_state.pending_msg_events;
2994                 channel_state.by_id.retain(|_, chan| {
2995                         if chan.get_their_node_id() == *their_node_id {
2996                                 if !chan.have_received_message() {
2997                                         // If we created this (outbound) channel while we were disconnected from the
2998                                         // peer we probably failed to send the open_channel message, which is now
2999                                         // lost. We can't have had anything pending related to this channel, so we just
3000                                         // drop it.
3001                                         false
3002                                 } else {
3003                                         pending_msg_events.push(events::MessageSendEvent::SendChannelReestablish {
3004                                                 node_id: chan.get_their_node_id(),
3005                                                 msg: chan.get_channel_reestablish(),
3006                                         });
3007                                         true
3008                                 }
3009                         } else { true }
3010                 });
3011                 //TODO: Also re-broadcast announcement_signatures
3012         }
3013
3014         fn handle_error(&self, their_node_id: &PublicKey, msg: &msgs::ErrorMessage) {
3015                 let _ = self.total_consistency_lock.read().unwrap();
3016
3017                 if msg.channel_id == [0; 32] {
3018                         for chan in self.list_channels() {
3019                                 if chan.remote_network_id == *their_node_id {
3020                                         self.force_close_channel(&chan.channel_id);
3021                                 }
3022                         }
3023                 } else {
3024                         self.force_close_channel(&msg.channel_id);
3025                 }
3026         }
3027 }
3028
3029 const SERIALIZATION_VERSION: u8 = 1;
3030 const MIN_SERIALIZATION_VERSION: u8 = 1;
3031
3032 impl Writeable for PendingHTLCInfo {
3033         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3034                 self.onion_packet.write(writer)?;
3035                 self.incoming_shared_secret.write(writer)?;
3036                 self.payment_hash.write(writer)?;
3037                 self.short_channel_id.write(writer)?;
3038                 self.amt_to_forward.write(writer)?;
3039                 self.outgoing_cltv_value.write(writer)?;
3040                 Ok(())
3041         }
3042 }
3043
3044 impl<R: ::std::io::Read> Readable<R> for PendingHTLCInfo {
3045         fn read(reader: &mut R) -> Result<PendingHTLCInfo, DecodeError> {
3046                 Ok(PendingHTLCInfo {
3047                         onion_packet: Readable::read(reader)?,
3048                         incoming_shared_secret: Readable::read(reader)?,
3049                         payment_hash: Readable::read(reader)?,
3050                         short_channel_id: Readable::read(reader)?,
3051                         amt_to_forward: Readable::read(reader)?,
3052                         outgoing_cltv_value: Readable::read(reader)?,
3053                 })
3054         }
3055 }
3056
3057 impl Writeable for HTLCFailureMsg {
3058         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3059                 match self {
3060                         &HTLCFailureMsg::Relay(ref fail_msg) => {
3061                                 0u8.write(writer)?;
3062                                 fail_msg.write(writer)?;
3063                         },
3064                         &HTLCFailureMsg::Malformed(ref fail_msg) => {
3065                                 1u8.write(writer)?;
3066                                 fail_msg.write(writer)?;
3067                         }
3068                 }
3069                 Ok(())
3070         }
3071 }
3072
3073 impl<R: ::std::io::Read> Readable<R> for HTLCFailureMsg {
3074         fn read(reader: &mut R) -> Result<HTLCFailureMsg, DecodeError> {
3075                 match <u8 as Readable<R>>::read(reader)? {
3076                         0 => Ok(HTLCFailureMsg::Relay(Readable::read(reader)?)),
3077                         1 => Ok(HTLCFailureMsg::Malformed(Readable::read(reader)?)),
3078                         _ => Err(DecodeError::InvalidValue),
3079                 }
3080         }
3081 }
3082
3083 impl Writeable for PendingHTLCStatus {
3084         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3085                 match self {
3086                         &PendingHTLCStatus::Forward(ref forward_info) => {
3087                                 0u8.write(writer)?;
3088                                 forward_info.write(writer)?;
3089                         },
3090                         &PendingHTLCStatus::Fail(ref fail_msg) => {
3091                                 1u8.write(writer)?;
3092                                 fail_msg.write(writer)?;
3093                         }
3094                 }
3095                 Ok(())
3096         }
3097 }
3098
3099 impl<R: ::std::io::Read> Readable<R> for PendingHTLCStatus {
3100         fn read(reader: &mut R) -> Result<PendingHTLCStatus, DecodeError> {
3101                 match <u8 as Readable<R>>::read(reader)? {
3102                         0 => Ok(PendingHTLCStatus::Forward(Readable::read(reader)?)),
3103                         1 => Ok(PendingHTLCStatus::Fail(Readable::read(reader)?)),
3104                         _ => Err(DecodeError::InvalidValue),
3105                 }
3106         }
3107 }
3108
3109 impl_writeable!(HTLCPreviousHopData, 0, {
3110         short_channel_id,
3111         htlc_id,
3112         incoming_packet_shared_secret
3113 });
3114
3115 impl Writeable for HTLCSource {
3116         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3117                 match self {
3118                         &HTLCSource::PreviousHopData(ref hop_data) => {
3119                                 0u8.write(writer)?;
3120                                 hop_data.write(writer)?;
3121                         },
3122                         &HTLCSource::OutboundRoute { ref route, ref session_priv, ref first_hop_htlc_msat } => {
3123                                 1u8.write(writer)?;
3124                                 route.write(writer)?;
3125                                 session_priv.write(writer)?;
3126                                 first_hop_htlc_msat.write(writer)?;
3127                         }
3128                 }
3129                 Ok(())
3130         }
3131 }
3132
3133 impl<R: ::std::io::Read> Readable<R> for HTLCSource {
3134         fn read(reader: &mut R) -> Result<HTLCSource, DecodeError> {
3135                 match <u8 as Readable<R>>::read(reader)? {
3136                         0 => Ok(HTLCSource::PreviousHopData(Readable::read(reader)?)),
3137                         1 => Ok(HTLCSource::OutboundRoute {
3138                                 route: Readable::read(reader)?,
3139                                 session_priv: Readable::read(reader)?,
3140                                 first_hop_htlc_msat: Readable::read(reader)?,
3141                         }),
3142                         _ => Err(DecodeError::InvalidValue),
3143                 }
3144         }
3145 }
3146
3147 impl Writeable for HTLCFailReason {
3148         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3149                 match self {
3150                         &HTLCFailReason::LightningError { ref err } => {
3151                                 0u8.write(writer)?;
3152                                 err.write(writer)?;
3153                         },
3154                         &HTLCFailReason::Reason { ref failure_code, ref data } => {
3155                                 1u8.write(writer)?;
3156                                 failure_code.write(writer)?;
3157                                 data.write(writer)?;
3158                         }
3159                 }
3160                 Ok(())
3161         }
3162 }
3163
3164 impl<R: ::std::io::Read> Readable<R> for HTLCFailReason {
3165         fn read(reader: &mut R) -> Result<HTLCFailReason, DecodeError> {
3166                 match <u8 as Readable<R>>::read(reader)? {
3167                         0 => Ok(HTLCFailReason::LightningError { err: Readable::read(reader)? }),
3168                         1 => Ok(HTLCFailReason::Reason {
3169                                 failure_code: Readable::read(reader)?,
3170                                 data: Readable::read(reader)?,
3171                         }),
3172                         _ => Err(DecodeError::InvalidValue),
3173                 }
3174         }
3175 }
3176
3177 impl Writeable for HTLCForwardInfo {
3178         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3179                 match self {
3180                         &HTLCForwardInfo::AddHTLC { ref prev_short_channel_id, ref prev_htlc_id, ref forward_info } => {
3181                                 0u8.write(writer)?;
3182                                 prev_short_channel_id.write(writer)?;
3183                                 prev_htlc_id.write(writer)?;
3184                                 forward_info.write(writer)?;
3185                         },
3186                         &HTLCForwardInfo::FailHTLC { ref htlc_id, ref err_packet } => {
3187                                 1u8.write(writer)?;
3188                                 htlc_id.write(writer)?;
3189                                 err_packet.write(writer)?;
3190                         },
3191                 }
3192                 Ok(())
3193         }
3194 }
3195
3196 impl<R: ::std::io::Read> Readable<R> for HTLCForwardInfo {
3197         fn read(reader: &mut R) -> Result<HTLCForwardInfo, DecodeError> {
3198                 match <u8 as Readable<R>>::read(reader)? {
3199                         0 => Ok(HTLCForwardInfo::AddHTLC {
3200                                 prev_short_channel_id: Readable::read(reader)?,
3201                                 prev_htlc_id: Readable::read(reader)?,
3202                                 forward_info: Readable::read(reader)?,
3203                         }),
3204                         1 => Ok(HTLCForwardInfo::FailHTLC {
3205                                 htlc_id: Readable::read(reader)?,
3206                                 err_packet: Readable::read(reader)?,
3207                         }),
3208                         _ => Err(DecodeError::InvalidValue),
3209                 }
3210         }
3211 }
3212
3213 impl<ChanSigner: ChannelKeys + Writeable, M: Deref> Writeable for ChannelManager<ChanSigner, M> where M::Target: ManyChannelMonitor {
3214         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
3215                 let _ = self.total_consistency_lock.write().unwrap();
3216
3217                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
3218                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
3219
3220                 self.genesis_hash.write(writer)?;
3221                 (self.latest_block_height.load(Ordering::Acquire) as u32).write(writer)?;
3222                 self.last_block_hash.lock().unwrap().write(writer)?;
3223
3224                 let channel_state = self.channel_state.lock().unwrap();
3225                 let mut unfunded_channels = 0;
3226                 for (_, channel) in channel_state.by_id.iter() {
3227                         if !channel.is_funding_initiated() {
3228                                 unfunded_channels += 1;
3229                         }
3230                 }
3231                 ((channel_state.by_id.len() - unfunded_channels) as u64).write(writer)?;
3232                 for (_, channel) in channel_state.by_id.iter() {
3233                         if channel.is_funding_initiated() {
3234                                 channel.write(writer)?;
3235                         }
3236                 }
3237
3238                 (channel_state.forward_htlcs.len() as u64).write(writer)?;
3239                 for (short_channel_id, pending_forwards) in channel_state.forward_htlcs.iter() {
3240                         short_channel_id.write(writer)?;
3241                         (pending_forwards.len() as u64).write(writer)?;
3242                         for forward in pending_forwards {
3243                                 forward.write(writer)?;
3244                         }
3245                 }
3246
3247                 (channel_state.claimable_htlcs.len() as u64).write(writer)?;
3248                 for (payment_hash, previous_hops) in channel_state.claimable_htlcs.iter() {
3249                         payment_hash.write(writer)?;
3250                         (previous_hops.len() as u64).write(writer)?;
3251                         for &(recvd_amt, ref previous_hop) in previous_hops.iter() {
3252                                 recvd_amt.write(writer)?;
3253                                 previous_hop.write(writer)?;
3254                         }
3255                 }
3256
3257                 let per_peer_state = self.per_peer_state.write().unwrap();
3258                 (per_peer_state.len() as u64).write(writer)?;
3259                 for (peer_pubkey, peer_state_mutex) in per_peer_state.iter() {
3260                         peer_pubkey.write(writer)?;
3261                         let peer_state = peer_state_mutex.lock().unwrap();
3262                         peer_state.latest_features.write(writer)?;
3263                 }
3264
3265                 (self.last_node_announcement_serial.load(Ordering::Acquire) as u32).write(writer)?;
3266
3267                 Ok(())
3268         }
3269 }
3270
3271 /// Arguments for the creation of a ChannelManager that are not deserialized.
3272 ///
3273 /// At a high-level, the process for deserializing a ChannelManager and resuming normal operation
3274 /// is:
3275 /// 1) Deserialize all stored ChannelMonitors.
3276 /// 2) Deserialize the ChannelManager by filling in this struct and calling <(Sha256dHash,
3277 ///    ChannelManager)>::read(reader, args).
3278 ///    This may result in closing some Channels if the ChannelMonitor is newer than the stored
3279 ///    ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
3280 /// 3) Register all relevant ChannelMonitor outpoints with your chain watch mechanism using
3281 ///    ChannelMonitor::get_monitored_outpoints and ChannelMonitor::get_funding_txo().
3282 /// 4) Reconnect blocks on your ChannelMonitors.
3283 /// 5) Move the ChannelMonitors into your local ManyChannelMonitor.
3284 /// 6) Disconnect/connect blocks on the ChannelManager.
3285 /// 7) Register the new ChannelManager with your ChainWatchInterface.
3286 pub struct ChannelManagerReadArgs<'a, ChanSigner: ChannelKeys, M: Deref> where M::Target: ManyChannelMonitor {
3287         /// The keys provider which will give us relevant keys. Some keys will be loaded during
3288         /// deserialization.
3289         pub keys_manager: Arc<KeysInterface<ChanKeySigner = ChanSigner>>,
3290
3291         /// The fee_estimator for use in the ChannelManager in the future.
3292         ///
3293         /// No calls to the FeeEstimator will be made during deserialization.
3294         pub fee_estimator: Arc<FeeEstimator>,
3295         /// The ManyChannelMonitor for use in the ChannelManager in the future.
3296         ///
3297         /// No calls to the ManyChannelMonitor will be made during deserialization. It is assumed that
3298         /// you have deserialized ChannelMonitors separately and will add them to your
3299         /// ManyChannelMonitor after deserializing this ChannelManager.
3300         pub monitor: M,
3301
3302         /// The BroadcasterInterface which will be used in the ChannelManager in the future and may be
3303         /// used to broadcast the latest local commitment transactions of channels which must be
3304         /// force-closed during deserialization.
3305         pub tx_broadcaster: Arc<BroadcasterInterface>,
3306         /// The Logger for use in the ChannelManager and which may be used to log information during
3307         /// deserialization.
3308         pub logger: Arc<Logger>,
3309         /// Default settings used for new channels. Any existing channels will continue to use the
3310         /// runtime settings which were stored when the ChannelManager was serialized.
3311         pub default_config: UserConfig,
3312
3313         /// A map from channel funding outpoints to ChannelMonitors for those channels (ie
3314         /// value.get_funding_txo() should be the key).
3315         ///
3316         /// If a monitor is inconsistent with the channel state during deserialization the channel will
3317         /// be force-closed using the data in the ChannelMonitor and the channel will be dropped. This
3318         /// is true for missing channels as well. If there is a monitor missing for which we find
3319         /// channel data Err(DecodeError::InvalidValue) will be returned.
3320         ///
3321         /// In such cases the latest local transactions will be sent to the tx_broadcaster included in
3322         /// this struct.
3323         pub channel_monitors: &'a mut HashMap<OutPoint, &'a mut ChannelMonitor>,
3324 }
3325
3326 impl<'a, R : ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>, M: Deref> ReadableArgs<R, ChannelManagerReadArgs<'a, ChanSigner, M>> for (Sha256dHash, ChannelManager<ChanSigner, M>) where M::Target: ManyChannelMonitor {
3327         fn read(reader: &mut R, args: ChannelManagerReadArgs<'a, ChanSigner, M>) -> Result<Self, DecodeError> {
3328                 let _ver: u8 = Readable::read(reader)?;
3329                 let min_ver: u8 = Readable::read(reader)?;
3330                 if min_ver > SERIALIZATION_VERSION {
3331                         return Err(DecodeError::UnknownVersion);
3332                 }
3333
3334                 let genesis_hash: Sha256dHash = Readable::read(reader)?;
3335                 let latest_block_height: u32 = Readable::read(reader)?;
3336                 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3337
3338                 let mut closed_channels = Vec::new();
3339
3340                 let channel_count: u64 = Readable::read(reader)?;
3341                 let mut funding_txo_set = HashSet::with_capacity(cmp::min(channel_count as usize, 128));
3342                 let mut by_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3343                 let mut short_to_id = HashMap::with_capacity(cmp::min(channel_count as usize, 128));
3344                 for _ in 0..channel_count {
3345                         let mut channel: Channel<ChanSigner> = ReadableArgs::read(reader, args.logger.clone())?;
3346                         if channel.last_block_connected != last_block_hash {
3347                                 return Err(DecodeError::InvalidValue);
3348                         }
3349
3350                         let funding_txo = channel.channel_monitor().get_funding_txo().ok_or(DecodeError::InvalidValue)?;
3351                         funding_txo_set.insert(funding_txo.clone());
3352                         if let Some(ref mut monitor) = args.channel_monitors.get_mut(&funding_txo) {
3353                                 if channel.get_cur_local_commitment_transaction_number() != monitor.get_cur_local_commitment_number() ||
3354                                                 channel.get_revoked_remote_commitment_transaction_number() != monitor.get_min_seen_secret() ||
3355                                                 channel.get_cur_remote_commitment_transaction_number() != monitor.get_cur_remote_commitment_number() {
3356                                         let mut force_close_res = channel.force_shutdown();
3357                                         force_close_res.0 = monitor.get_latest_local_commitment_txn();
3358                                         closed_channels.push(force_close_res);
3359                                 } else {
3360                                         if let Some(short_channel_id) = channel.get_short_channel_id() {
3361                                                 short_to_id.insert(short_channel_id, channel.channel_id());
3362                                         }
3363                                         by_id.insert(channel.channel_id(), channel);
3364                                 }
3365                         } else {
3366                                 return Err(DecodeError::InvalidValue);
3367                         }
3368                 }
3369
3370                 for (ref funding_txo, ref mut monitor) in args.channel_monitors.iter_mut() {
3371                         if !funding_txo_set.contains(funding_txo) {
3372                                 closed_channels.push((monitor.get_latest_local_commitment_txn(), Vec::new()));
3373                         }
3374                 }
3375
3376                 let forward_htlcs_count: u64 = Readable::read(reader)?;
3377                 let mut forward_htlcs = HashMap::with_capacity(cmp::min(forward_htlcs_count as usize, 128));
3378                 for _ in 0..forward_htlcs_count {
3379                         let short_channel_id = Readable::read(reader)?;
3380                         let pending_forwards_count: u64 = Readable::read(reader)?;
3381                         let mut pending_forwards = Vec::with_capacity(cmp::min(pending_forwards_count as usize, 128));
3382                         for _ in 0..pending_forwards_count {
3383                                 pending_forwards.push(Readable::read(reader)?);
3384                         }
3385                         forward_htlcs.insert(short_channel_id, pending_forwards);
3386                 }
3387
3388                 let claimable_htlcs_count: u64 = Readable::read(reader)?;
3389                 let mut claimable_htlcs = HashMap::with_capacity(cmp::min(claimable_htlcs_count as usize, 128));
3390                 for _ in 0..claimable_htlcs_count {
3391                         let payment_hash = Readable::read(reader)?;
3392                         let previous_hops_len: u64 = Readable::read(reader)?;
3393                         let mut previous_hops = Vec::with_capacity(cmp::min(previous_hops_len as usize, 2));
3394                         for _ in 0..previous_hops_len {
3395                                 previous_hops.push((Readable::read(reader)?, Readable::read(reader)?));
3396                         }
3397                         claimable_htlcs.insert(payment_hash, previous_hops);
3398                 }
3399
3400                 let peer_count: u64 = Readable::read(reader)?;
3401                 let mut per_peer_state = HashMap::with_capacity(cmp::min(peer_count as usize, 128));
3402                 for _ in 0..peer_count {
3403                         let peer_pubkey = Readable::read(reader)?;
3404                         let peer_state = PeerState {
3405                                 latest_features: Readable::read(reader)?,
3406                         };
3407                         per_peer_state.insert(peer_pubkey, Mutex::new(peer_state));
3408                 }
3409
3410                 let last_node_announcement_serial: u32 = Readable::read(reader)?;
3411
3412                 let channel_manager = ChannelManager {
3413                         genesis_hash,
3414                         fee_estimator: args.fee_estimator,
3415                         monitor: args.monitor,
3416                         tx_broadcaster: args.tx_broadcaster,
3417
3418                         latest_block_height: AtomicUsize::new(latest_block_height as usize),
3419                         last_block_hash: Mutex::new(last_block_hash),
3420                         secp_ctx: Secp256k1::new(),
3421
3422                         channel_state: Mutex::new(ChannelHolder {
3423                                 by_id,
3424                                 short_to_id,
3425                                 forward_htlcs,
3426                                 claimable_htlcs,
3427                                 pending_msg_events: Vec::new(),
3428                         }),
3429                         our_network_key: args.keys_manager.get_node_secret(),
3430
3431                         last_node_announcement_serial: AtomicUsize::new(last_node_announcement_serial as usize),
3432
3433                         per_peer_state: RwLock::new(per_peer_state),
3434
3435                         pending_events: Mutex::new(Vec::new()),
3436                         total_consistency_lock: RwLock::new(()),
3437                         keys_manager: args.keys_manager,
3438                         logger: args.logger,
3439                         default_configuration: args.default_config,
3440                 };
3441
3442                 for close_res in closed_channels.drain(..) {
3443                         channel_manager.finish_force_close_channel(close_res);
3444                         //TODO: Broadcast channel update for closed channels, but only after we've made a
3445                         //connection or two.
3446                 }
3447
3448                 Ok((last_block_hash.clone(), channel_manager))
3449         }
3450 }