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