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