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