Create ChannelMonitors with basic_channel_info and funding_info set
[rust-lightning] / lightning / src / ln / channelmonitor.rs
1 //! The logic to monitor for on-chain transactions and create the relevant claim responses lives
2 //! here.
3 //!
4 //! ChannelMonitor objects are generated by ChannelManager in response to relevant
5 //! messages/actions, and MUST be persisted to disk (and, preferably, remotely) before progress can
6 //! be made in responding to certain messages, see ManyChannelMonitor for more.
7 //!
8 //! Note that ChannelMonitors are an important part of the lightning trust model and a copy of the
9 //! latest ChannelMonitor must always be actively monitoring for chain updates (and no out-of-date
10 //! ChannelMonitors should do so). Thus, if you're building rust-lightning into an HSM or other
11 //! security-domain-separated system design, you should consider having multiple paths for
12 //! ChannelMonitors to get out of the HSM and onto monitoring devices.
13
14 use bitcoin::blockdata::block::BlockHeader;
15 use bitcoin::blockdata::transaction::{TxIn,TxOut,SigHashType,Transaction};
16 use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
17 use bitcoin::blockdata::script::{Script, Builder};
18 use bitcoin::blockdata::opcodes;
19 use bitcoin::consensus::encode;
20 use bitcoin::util::hash::BitcoinHash;
21 use bitcoin::util::bip143;
22
23 use bitcoin_hashes::Hash;
24 use bitcoin_hashes::sha256::Hash as Sha256;
25 use bitcoin_hashes::hash160::Hash as Hash160;
26 use bitcoin_hashes::sha256d::Hash as Sha256dHash;
27
28 use secp256k1::{Secp256k1,Signature};
29 use secp256k1::key::{SecretKey,PublicKey};
30 use secp256k1;
31
32 use ln::msgs::DecodeError;
33 use ln::chan_utils;
34 use ln::chan_utils::{CounterpartyCommitmentSecrets, HTLCOutputInCommitment, LocalCommitmentTransaction, HTLCType};
35 use ln::channelmanager::{HTLCSource, PaymentPreimage, PaymentHash};
36 use chain::chaininterface::{ChainListener, ChainWatchInterface, BroadcasterInterface, FeeEstimator, ConfirmationTarget, MIN_RELAY_FEE_SAT_PER_1000_WEIGHT};
37 use chain::transaction::OutPoint;
38 use chain::keysinterface::{SpendableOutputDescriptor, ChannelKeys};
39 use util::logger::Logger;
40 use util::ser::{ReadableArgs, Readable, Writer, Writeable, U48};
41 use util::{byte_utils, events};
42
43 use std::collections::{HashMap, hash_map, HashSet};
44 use std::sync::{Arc,Mutex};
45 use std::{hash,cmp, mem};
46 use std::ops::Deref;
47
48 /// An update generated by the underlying Channel itself which contains some new information the
49 /// ChannelMonitor should be made aware of.
50 #[cfg_attr(test, derive(PartialEq))]
51 #[derive(Clone)]
52 #[must_use]
53 pub struct ChannelMonitorUpdate {
54         pub(super) updates: Vec<ChannelMonitorUpdateStep>,
55         /// The sequence number of this update. Updates *must* be replayed in-order according to this
56         /// sequence number (and updates may panic if they are not). The update_id values are strictly
57         /// increasing and increase by one for each new update.
58         ///
59         /// This sequence number is also used to track up to which points updates which returned
60         /// ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
61         /// ChannelMonitor when ChannelManager::channel_monitor_updated is called.
62         pub update_id: u64,
63 }
64
65 impl Writeable for ChannelMonitorUpdate {
66         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
67                 self.update_id.write(w)?;
68                 (self.updates.len() as u64).write(w)?;
69                 for update_step in self.updates.iter() {
70                         update_step.write(w)?;
71                 }
72                 Ok(())
73         }
74 }
75 impl<R: ::std::io::Read> Readable<R> for ChannelMonitorUpdate {
76         fn read(r: &mut R) -> Result<Self, DecodeError> {
77                 let update_id: u64 = Readable::read(r)?;
78                 let len: u64 = Readable::read(r)?;
79                 let mut updates = Vec::with_capacity(cmp::min(len as usize, MAX_ALLOC_SIZE / ::std::mem::size_of::<ChannelMonitorUpdateStep>()));
80                 for _ in 0..len {
81                         updates.push(Readable::read(r)?);
82                 }
83                 Ok(Self { update_id, updates })
84         }
85 }
86
87 /// An error enum representing a failure to persist a channel monitor update.
88 #[derive(Clone)]
89 pub enum ChannelMonitorUpdateErr {
90         /// Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
91         /// our state failed, but is expected to succeed at some point in the future).
92         ///
93         /// Such a failure will "freeze" a channel, preventing us from revoking old states or
94         /// submitting new commitment transactions to the remote party. Once the update(s) which failed
95         /// have been successfully applied, ChannelManager::channel_monitor_updated can be used to
96         /// restore the channel to an operational state.
97         ///
98         /// Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
99         /// you return a TemporaryFailure you must ensure that it is written to disk safely before
100         /// writing out the latest ChannelManager state.
101         ///
102         /// Even when a channel has been "frozen" updates to the ChannelMonitor can continue to occur
103         /// (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
104         /// to claim it on this channel) and those updates must be applied wherever they can be. At
105         /// least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
106         /// be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
107         /// the channel which would invalidate previous ChannelMonitors are not made when a channel has
108         /// been "frozen".
109         ///
110         /// Note that even if updates made after TemporaryFailure succeed you must still call
111         /// channel_monitor_updated to ensure you have the latest monitor and re-enable normal channel
112         /// operation.
113         ///
114         /// Note that the update being processed here will not be replayed for you when you call
115         /// ChannelManager::channel_monitor_updated, so you must store the update itself along
116         /// with the persisted ChannelMonitor on your own local disk prior to returning a
117         /// TemporaryFailure. You may, of course, employ a journaling approach, storing only the
118         /// ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
119         /// reload-time.
120         ///
121         /// For deployments where a copy of ChannelMonitors and other local state are backed up in a
122         /// remote location (with local copies persisted immediately), it is anticipated that all
123         /// updates will return TemporaryFailure until the remote copies could be updated.
124         TemporaryFailure,
125         /// Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
126         /// different watchtower and cannot update with all watchtowers that were previously informed
127         /// of this channel). This will force-close the channel in question.
128         ///
129         /// Should also be used to indicate a failure to update the local copy of the channel monitor.
130         PermanentFailure,
131 }
132
133 /// General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
134 /// inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::insert_combine this
135 /// means you tried to merge two monitors for different channels or for a channel which was
136 /// restored from a backup and then generated new commitment updates.
137 /// Contains a human-readable error message.
138 #[derive(Debug)]
139 pub struct MonitorUpdateError(pub &'static str);
140
141 /// Simple structure send back by ManyChannelMonitor in case of HTLC detected onchain from a
142 /// forward channel and from which info are needed to update HTLC in a backward channel.
143 #[derive(Clone, PartialEq)]
144 pub struct HTLCUpdate {
145         pub(super) payment_hash: PaymentHash,
146         pub(super) payment_preimage: Option<PaymentPreimage>,
147         pub(super) source: HTLCSource
148 }
149 impl_writeable!(HTLCUpdate, 0, { payment_hash, payment_preimage, source });
150
151 /// Simple trait indicating ability to track a set of ChannelMonitors and multiplex events between
152 /// them. Generally should be implemented by keeping a local SimpleManyChannelMonitor and passing
153 /// events to it, while also taking any add_update_monitor events and passing them to some remote
154 /// server(s).
155 ///
156 /// Note that any updates to a channel's monitor *must* be applied to each instance of the
157 /// channel's monitor everywhere (including remote watchtowers) *before* this function returns. If
158 /// an update occurs and a remote watchtower is left with old state, it may broadcast transactions
159 /// which we have revoked, allowing our counterparty to claim all funds in the channel!
160 ///
161 /// User needs to notify implementors of ManyChannelMonitor when a new block is connected or
162 /// disconnected using their `block_connected` and `block_disconnected` methods. However, rather
163 /// than calling these methods directly, the user should register implementors as listeners to the
164 /// BlockNotifier and call the BlockNotifier's `block_(dis)connected` methods, which will notify
165 /// all registered listeners in one go.
166 pub trait ManyChannelMonitor<ChanSigner: ChannelKeys>: Send + Sync {
167         /// Adds or updates a monitor for the given `funding_txo`.
168         ///
169         /// Implementer must also ensure that the funding_txo txid *and* outpoint are registered with
170         /// any relevant ChainWatchInterfaces such that the provided monitor receives block_connected
171         /// callbacks with the funding transaction, or any spends of it.
172         ///
173         /// Further, the implementer must also ensure that each output returned in
174         /// monitor.get_outputs_to_watch() is registered to ensure that the provided monitor learns about
175         /// any spends of any of the outputs.
176         ///
177         /// Any spends of outputs which should have been registered which aren't passed to
178         /// ChannelMonitors via block_connected may result in FUNDS LOSS.
179         fn add_update_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitor<ChanSigner>) -> Result<(), ChannelMonitorUpdateErr>;
180
181         /// Updates a monitor for the given `funding_txo`.
182         ///
183         /// Implementer must also ensure that the funding_txo txid *and* outpoint are registered with
184         /// any relevant ChainWatchInterfaces such that the provided monitor receives block_connected
185         /// callbacks with the funding transaction, or any spends of it.
186         ///
187         /// Further, the implementer must also ensure that each output returned in
188         /// monitor.get_watch_outputs() is registered to ensure that the provided monitor learns about
189         /// any spends of any of the outputs.
190         ///
191         /// Any spends of outputs which should have been registered which aren't passed to
192         /// ChannelMonitors via block_connected may result in FUNDS LOSS.
193         fn update_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitorUpdate) -> Result<(), ChannelMonitorUpdateErr>;
194
195         /// Used by ChannelManager to get list of HTLC resolved onchain and which needed to be updated
196         /// with success or failure.
197         ///
198         /// You should probably just call through to
199         /// ChannelMonitor::get_and_clear_pending_htlcs_updated() for each ChannelMonitor and return
200         /// the full list.
201         fn get_and_clear_pending_htlcs_updated(&self) -> Vec<HTLCUpdate>;
202 }
203
204 /// A simple implementation of a ManyChannelMonitor and ChainListener. Can be used to create a
205 /// watchtower or watch our own channels.
206 ///
207 /// Note that you must provide your own key by which to refer to channels.
208 ///
209 /// If you're accepting remote monitors (ie are implementing a watchtower), you must verify that
210 /// users cannot overwrite a given channel by providing a duplicate key. ie you should probably
211 /// index by a PublicKey which is required to sign any updates.
212 ///
213 /// If you're using this for local monitoring of your own channels, you probably want to use
214 /// `OutPoint` as the key, which will give you a ManyChannelMonitor implementation.
215 pub struct SimpleManyChannelMonitor<Key, ChanSigner: ChannelKeys, T: Deref> where T::Target: BroadcasterInterface {
216         #[cfg(test)] // Used in ChannelManager tests to manipulate channels directly
217         pub monitors: Mutex<HashMap<Key, ChannelMonitor<ChanSigner>>>,
218         #[cfg(not(test))]
219         monitors: Mutex<HashMap<Key, ChannelMonitor<ChanSigner>>>,
220         chain_monitor: Arc<ChainWatchInterface>,
221         broadcaster: T,
222         pending_events: Mutex<Vec<events::Event>>,
223         logger: Arc<Logger>,
224         fee_estimator: Arc<FeeEstimator>
225 }
226
227 impl<'a, Key : Send + cmp::Eq + hash::Hash, ChanSigner: ChannelKeys, T: Deref + Sync + Send> ChainListener for SimpleManyChannelMonitor<Key, ChanSigner, T>
228         where T::Target: BroadcasterInterface
229 {
230         fn block_connected(&self, header: &BlockHeader, height: u32, txn_matched: &[&Transaction], _indexes_of_txn_matched: &[u32]) {
231                 let block_hash = header.bitcoin_hash();
232                 let mut new_events: Vec<events::Event> = Vec::with_capacity(0);
233                 {
234                         let mut monitors = self.monitors.lock().unwrap();
235                         for monitor in monitors.values_mut() {
236                                 let (txn_outputs, spendable_outputs) = monitor.block_connected(txn_matched, height, &block_hash, &*self.broadcaster, &*self.fee_estimator);
237                                 if spendable_outputs.len() > 0 {
238                                         new_events.push(events::Event::SpendableOutputs {
239                                                 outputs: spendable_outputs,
240                                         });
241                                 }
242
243                                 for (ref txid, ref outputs) in txn_outputs {
244                                         for (idx, output) in outputs.iter().enumerate() {
245                                                 self.chain_monitor.install_watch_outpoint((txid.clone(), idx as u32), &output.script_pubkey);
246                                         }
247                                 }
248                         }
249                 }
250                 let mut pending_events = self.pending_events.lock().unwrap();
251                 pending_events.append(&mut new_events);
252         }
253
254         fn block_disconnected(&self, header: &BlockHeader, disconnected_height: u32) {
255                 let block_hash = header.bitcoin_hash();
256                 let mut monitors = self.monitors.lock().unwrap();
257                 for monitor in monitors.values_mut() {
258                         monitor.block_disconnected(disconnected_height, &block_hash, &*self.broadcaster, &*self.fee_estimator);
259                 }
260         }
261 }
262
263 impl<Key : Send + cmp::Eq + hash::Hash + 'static, ChanSigner: ChannelKeys, T: Deref> SimpleManyChannelMonitor<Key, ChanSigner, T>
264         where T::Target: BroadcasterInterface
265 {
266         /// Creates a new object which can be used to monitor several channels given the chain
267         /// interface with which to register to receive notifications.
268         pub fn new(chain_monitor: Arc<ChainWatchInterface>, broadcaster: T, logger: Arc<Logger>, feeest: Arc<FeeEstimator>) -> SimpleManyChannelMonitor<Key, ChanSigner, T> {
269                 let res = SimpleManyChannelMonitor {
270                         monitors: Mutex::new(HashMap::new()),
271                         chain_monitor,
272                         broadcaster,
273                         pending_events: Mutex::new(Vec::new()),
274                         logger,
275                         fee_estimator: feeest,
276                 };
277
278                 res
279         }
280
281         /// Adds or updates the monitor which monitors the channel referred to by the given key.
282         pub fn add_update_monitor_by_key(&self, key: Key, monitor: ChannelMonitor<ChanSigner>) -> Result<(), MonitorUpdateError> {
283                 let mut monitors = self.monitors.lock().unwrap();
284                 match monitors.get_mut(&key) {
285                         Some(orig_monitor) => {
286                                 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(monitor.key_storage));
287                                 return orig_monitor.insert_combine(monitor);
288                         },
289                         None => {}
290                 };
291                 match monitor.key_storage {
292                         Storage::Local { ref funding_info, .. } => {
293                                 match funding_info {
294                                         &None => {
295                                                 return Err(MonitorUpdateError("Try to update a useless monitor without funding_txo !"));
296                                         },
297                                         &Some((ref outpoint, ref script)) => {
298                                                 log_trace!(self, "Got new Channel Monitor for channel {}", log_bytes!(outpoint.to_channel_id()[..]));
299                                                 self.chain_monitor.install_watch_tx(&outpoint.txid, script);
300                                                 self.chain_monitor.install_watch_outpoint((outpoint.txid, outpoint.index as u32), script);
301                                         },
302                                 }
303                         },
304                         Storage::Watchtower { .. } => {
305                                 self.chain_monitor.watch_all_txn();
306                         }
307                 }
308                 for (txid, outputs) in monitor.get_outputs_to_watch().iter() {
309                         for (idx, script) in outputs.iter().enumerate() {
310                                 self.chain_monitor.install_watch_outpoint((*txid, idx as u32), script);
311                         }
312                 }
313                 monitors.insert(key, monitor);
314                 Ok(())
315         }
316
317         /// Updates the monitor which monitors the channel referred to by the given key.
318         pub fn update_monitor_by_key(&self, key: Key, update: ChannelMonitorUpdate) -> Result<(), MonitorUpdateError> {
319                 let mut monitors = self.monitors.lock().unwrap();
320                 match monitors.get_mut(&key) {
321                         Some(orig_monitor) => {
322                                 log_trace!(self, "Updating Channel Monitor for channel {}", log_funding_info!(orig_monitor.key_storage));
323                                 orig_monitor.update_monitor(update)
324                         },
325                         None => Err(MonitorUpdateError("No such monitor registered"))
326                 }
327         }
328 }
329
330 impl<ChanSigner: ChannelKeys, T: Deref + Sync + Send> ManyChannelMonitor<ChanSigner> for SimpleManyChannelMonitor<OutPoint, ChanSigner, T>
331         where T::Target: BroadcasterInterface
332 {
333         fn add_update_monitor(&self, funding_txo: OutPoint, monitor: ChannelMonitor<ChanSigner>) -> Result<(), ChannelMonitorUpdateErr> {
334                 match self.add_update_monitor_by_key(funding_txo, monitor) {
335                         Ok(_) => Ok(()),
336                         Err(_) => Err(ChannelMonitorUpdateErr::PermanentFailure),
337                 }
338         }
339
340         fn update_monitor(&self, funding_txo: OutPoint, update: ChannelMonitorUpdate) -> Result<(), ChannelMonitorUpdateErr> {
341                 match self.update_monitor_by_key(funding_txo, update) {
342                         Ok(_) => Ok(()),
343                         Err(_) => Err(ChannelMonitorUpdateErr::PermanentFailure),
344                 }
345         }
346
347         fn get_and_clear_pending_htlcs_updated(&self) -> Vec<HTLCUpdate> {
348                 let mut pending_htlcs_updated = Vec::new();
349                 for chan in self.monitors.lock().unwrap().values_mut() {
350                         pending_htlcs_updated.append(&mut chan.get_and_clear_pending_htlcs_updated());
351                 }
352                 pending_htlcs_updated
353         }
354 }
355
356 impl<Key : Send + cmp::Eq + hash::Hash, ChanSigner: ChannelKeys, T: Deref> events::EventsProvider for SimpleManyChannelMonitor<Key, ChanSigner, T>
357         where T::Target: BroadcasterInterface
358 {
359         fn get_and_clear_pending_events(&self) -> Vec<events::Event> {
360                 let mut pending_events = self.pending_events.lock().unwrap();
361                 let mut ret = Vec::new();
362                 mem::swap(&mut ret, &mut *pending_events);
363                 ret
364         }
365 }
366
367 /// If an HTLC expires within this many blocks, don't try to claim it in a shared transaction,
368 /// instead claiming it in its own individual transaction.
369 const CLTV_SHARED_CLAIM_BUFFER: u32 = 12;
370 /// If an HTLC expires within this many blocks, force-close the channel to broadcast the
371 /// HTLC-Success transaction.
372 /// In other words, this is an upper bound on how many blocks we think it can take us to get a
373 /// transaction confirmed (and we use it in a few more, equivalent, places).
374 pub(crate) const CLTV_CLAIM_BUFFER: u32 = 6;
375 /// Number of blocks by which point we expect our counterparty to have seen new blocks on the
376 /// network and done a full update_fail_htlc/commitment_signed dance (+ we've updated all our
377 /// copies of ChannelMonitors, including watchtowers). We could enforce the contract by failing
378 /// at CLTV expiration height but giving a grace period to our peer may be profitable for us if he
379 /// can provide an over-late preimage. Nevertheless, grace period has to be accounted in our
380 /// CLTV_EXPIRY_DELTA to be secure. Following this policy we may decrease the rate of channel failures
381 /// due to expiration but increase the cost of funds being locked longuer in case of failure.
382 /// This delay also cover a low-power peer being slow to process blocks and so being behind us on
383 /// accurate block height.
384 /// In case of onchain failure to be pass backward we may see the last block of ANTI_REORG_DELAY
385 /// with at worst this delay, so we are not only using this value as a mercy for them but also
386 /// us as a safeguard to delay with enough time.
387 pub(crate) const LATENCY_GRACE_PERIOD_BLOCKS: u32 = 3;
388 /// Number of blocks we wait on seeing a HTLC output being solved before we fail corresponding inbound
389 /// HTLCs. This prevents us from failing backwards and then getting a reorg resulting in us losing money.
390 /// We use also this delay to be sure we can remove our in-flight claim txn from bump candidates buffer.
391 /// It may cause spurrious generation of bumped claim txn but that's allright given the outpoint is already
392 /// solved by a previous claim tx. What we want to avoid is reorg evicting our claim tx and us not
393 /// keeping bumping another claim tx to solve the outpoint.
394 pub(crate) const ANTI_REORG_DELAY: u32 = 6;
395
396 #[derive(Clone)]
397 enum Storage<ChanSigner: ChannelKeys> {
398         Local {
399                 keys: ChanSigner,
400                 funding_key: SecretKey,
401                 revocation_base_key: SecretKey,
402                 htlc_base_key: SecretKey,
403                 delayed_payment_base_key: SecretKey,
404                 payment_base_key: SecretKey,
405                 shutdown_pubkey: PublicKey,
406                 funding_info: Option<(OutPoint, Script)>,
407                 current_remote_commitment_txid: Option<Sha256dHash>,
408                 prev_remote_commitment_txid: Option<Sha256dHash>,
409         },
410         Watchtower {
411                 revocation_base_key: PublicKey,
412                 htlc_base_key: PublicKey,
413         }
414 }
415
416 #[cfg(any(test, feature = "fuzztarget"))]
417 impl<ChanSigner: ChannelKeys> PartialEq for Storage<ChanSigner> {
418         fn eq(&self, other: &Self) -> bool {
419                 match *self {
420                         Storage::Local { ref keys, .. } => {
421                                 let k = keys;
422                                 match *other {
423                                         Storage::Local { ref keys, .. } => keys.pubkeys() == k.pubkeys(),
424                                         Storage::Watchtower { .. } => false,
425                                 }
426                         },
427                         Storage::Watchtower {ref revocation_base_key, ref htlc_base_key} => {
428                                 let (rbk, hbk) = (revocation_base_key, htlc_base_key);
429                                 match *other {
430                                         Storage::Local { .. } => false,
431                                         Storage::Watchtower {ref revocation_base_key, ref htlc_base_key} =>
432                                                 revocation_base_key == rbk && htlc_base_key == hbk,
433                                 }
434                         },
435                 }
436         }
437 }
438
439 #[derive(Clone, PartialEq)]
440 struct LocalSignedTx {
441         /// txid of the transaction in tx, just used to make comparison faster
442         txid: Sha256dHash,
443         tx: LocalCommitmentTransaction,
444         revocation_key: PublicKey,
445         a_htlc_key: PublicKey,
446         b_htlc_key: PublicKey,
447         delayed_payment_key: PublicKey,
448         per_commitment_point: PublicKey,
449         feerate_per_kw: u64,
450         htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
451 }
452
453 #[derive(PartialEq)]
454 enum InputDescriptors {
455         RevokedOfferedHTLC,
456         RevokedReceivedHTLC,
457         OfferedHTLC,
458         ReceivedHTLC,
459         RevokedOutput, // either a revoked to_local output on commitment tx, a revoked HTLC-Timeout output or a revoked HTLC-Success output
460 }
461
462 /// When ChannelMonitor discovers an onchain outpoint being a step of a channel and that it needs
463 /// to generate a tx to push channel state forward, we cache outpoint-solving tx material to build
464 /// a new bumped one in case of lenghty confirmation delay
465 #[derive(Clone, PartialEq)]
466 enum InputMaterial {
467         Revoked {
468                 script: Script,
469                 pubkey: Option<PublicKey>,
470                 key: SecretKey,
471                 is_htlc: bool,
472                 amount: u64,
473         },
474         RemoteHTLC {
475                 script: Script,
476                 key: SecretKey,
477                 preimage: Option<PaymentPreimage>,
478                 amount: u64,
479                 locktime: u32,
480         },
481         LocalHTLC {
482                 script: Script,
483                 sigs: (Signature, Signature),
484                 preimage: Option<PaymentPreimage>,
485                 amount: u64,
486         }
487 }
488
489 impl Writeable for InputMaterial  {
490         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
491                 match self {
492                         &InputMaterial::Revoked { ref script, ref pubkey, ref key, ref is_htlc, ref amount} => {
493                                 writer.write_all(&[0; 1])?;
494                                 script.write(writer)?;
495                                 pubkey.write(writer)?;
496                                 writer.write_all(&key[..])?;
497                                 if *is_htlc {
498                                         writer.write_all(&[0; 1])?;
499                                 } else {
500                                         writer.write_all(&[1; 1])?;
501                                 }
502                                 writer.write_all(&byte_utils::be64_to_array(*amount))?;
503                         },
504                         &InputMaterial::RemoteHTLC { ref script, ref key, ref preimage, ref amount, ref locktime } => {
505                                 writer.write_all(&[1; 1])?;
506                                 script.write(writer)?;
507                                 key.write(writer)?;
508                                 preimage.write(writer)?;
509                                 writer.write_all(&byte_utils::be64_to_array(*amount))?;
510                                 writer.write_all(&byte_utils::be32_to_array(*locktime))?;
511                         },
512                         &InputMaterial::LocalHTLC { ref script, ref sigs, ref preimage, ref amount } => {
513                                 writer.write_all(&[2; 1])?;
514                                 script.write(writer)?;
515                                 sigs.0.write(writer)?;
516                                 sigs.1.write(writer)?;
517                                 preimage.write(writer)?;
518                                 writer.write_all(&byte_utils::be64_to_array(*amount))?;
519                         }
520                 }
521                 Ok(())
522         }
523 }
524
525 impl<R: ::std::io::Read> Readable<R> for InputMaterial {
526         fn read(reader: &mut R) -> Result<Self, DecodeError> {
527                 let input_material = match <u8 as Readable<R>>::read(reader)? {
528                         0 => {
529                                 let script = Readable::read(reader)?;
530                                 let pubkey = Readable::read(reader)?;
531                                 let key = Readable::read(reader)?;
532                                 let is_htlc = match <u8 as Readable<R>>::read(reader)? {
533                                         0 => true,
534                                         1 => false,
535                                         _ => return Err(DecodeError::InvalidValue),
536                                 };
537                                 let amount = Readable::read(reader)?;
538                                 InputMaterial::Revoked {
539                                         script,
540                                         pubkey,
541                                         key,
542                                         is_htlc,
543                                         amount
544                                 }
545                         },
546                         1 => {
547                                 let script = Readable::read(reader)?;
548                                 let key = Readable::read(reader)?;
549                                 let preimage = Readable::read(reader)?;
550                                 let amount = Readable::read(reader)?;
551                                 let locktime = Readable::read(reader)?;
552                                 InputMaterial::RemoteHTLC {
553                                         script,
554                                         key,
555                                         preimage,
556                                         amount,
557                                         locktime
558                                 }
559                         },
560                         2 => {
561                                 let script = Readable::read(reader)?;
562                                 let their_sig = Readable::read(reader)?;
563                                 let our_sig = Readable::read(reader)?;
564                                 let preimage = Readable::read(reader)?;
565                                 let amount = Readable::read(reader)?;
566                                 InputMaterial::LocalHTLC {
567                                         script,
568                                         sigs: (their_sig, our_sig),
569                                         preimage,
570                                         amount
571                                 }
572                         }
573                         _ => return Err(DecodeError::InvalidValue),
574                 };
575                 Ok(input_material)
576         }
577 }
578
579 /// Upon discovering of some classes of onchain tx by ChannelMonitor, we may have to take actions on it
580 /// once they mature to enough confirmations (ANTI_REORG_DELAY)
581 #[derive(Clone, PartialEq)]
582 enum OnchainEvent {
583         /// Outpoint under claim process by our own tx, once this one get enough confirmations, we remove it from
584         /// bump-txn candidate buffer.
585         Claim {
586                 claim_request: Sha256dHash,
587         },
588         /// HTLC output getting solved by a timeout, at maturation we pass upstream payment source information to solve
589         /// inbound HTLC in backward channel. Note, in case of preimage, we pass info to upstream without delay as we can
590         /// only win from it, so it's never an OnchainEvent
591         HTLCUpdate {
592                 htlc_update: (HTLCSource, PaymentHash),
593         },
594         /// Claim tx aggregate multiple claimable outpoints. One of the outpoint may be claimed by a remote party tx.
595         /// In this case, we need to drop the outpoint and regenerate a new claim tx. By safety, we keep tracking
596         /// the outpoint to be sure to resurect it back to the claim tx if reorgs happen.
597         ContentiousOutpoint {
598                 outpoint: BitcoinOutPoint,
599                 input_material: InputMaterial,
600         }
601 }
602
603 /// Higher-level cache structure needed to re-generate bumped claim txn if needed
604 #[derive(Clone, PartialEq)]
605 pub struct ClaimTxBumpMaterial {
606         // At every block tick, used to check if pending claiming tx is taking too
607         // much time for confirmation and we need to bump it.
608         height_timer: u32,
609         // Tracked in case of reorg to wipe out now-superflous bump material
610         feerate_previous: u64,
611         // Soonest timelocks among set of outpoints claimed, used to compute
612         // a priority of not feerate
613         soonest_timelock: u32,
614         // Cache of script, pubkey, sig or key to solve claimable outputs scriptpubkey.
615         per_input_material: HashMap<BitcoinOutPoint, InputMaterial>,
616 }
617
618 impl Writeable for ClaimTxBumpMaterial  {
619         fn write<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
620                 writer.write_all(&byte_utils::be32_to_array(self.height_timer))?;
621                 writer.write_all(&byte_utils::be64_to_array(self.feerate_previous))?;
622                 writer.write_all(&byte_utils::be32_to_array(self.soonest_timelock))?;
623                 writer.write_all(&byte_utils::be64_to_array(self.per_input_material.len() as u64))?;
624                 for (outp, tx_material) in self.per_input_material.iter() {
625                         outp.write(writer)?;
626                         tx_material.write(writer)?;
627                 }
628                 Ok(())
629         }
630 }
631
632 impl<R: ::std::io::Read> Readable<R> for ClaimTxBumpMaterial {
633         fn read(reader: &mut R) -> Result<Self, DecodeError> {
634                 let height_timer = Readable::read(reader)?;
635                 let feerate_previous = Readable::read(reader)?;
636                 let soonest_timelock = Readable::read(reader)?;
637                 let per_input_material_len: u64 = Readable::read(reader)?;
638                 let mut per_input_material = HashMap::with_capacity(cmp::min(per_input_material_len as usize, MAX_ALLOC_SIZE / 128));
639                 for _ in 0 ..per_input_material_len {
640                         let outpoint = Readable::read(reader)?;
641                         let input_material = Readable::read(reader)?;
642                         per_input_material.insert(outpoint, input_material);
643                 }
644                 Ok(Self { height_timer, feerate_previous, soonest_timelock, per_input_material })
645         }
646 }
647
648 const SERIALIZATION_VERSION: u8 = 1;
649 const MIN_SERIALIZATION_VERSION: u8 = 1;
650
651 #[cfg_attr(test, derive(PartialEq))]
652 #[derive(Clone)]
653 pub(super) enum ChannelMonitorUpdateStep {
654         LatestLocalCommitmentTXInfo {
655                 // TODO: We really need to not be generating a fully-signed transaction in Channel and
656                 // passing it here, we need to hold off so that the ChanSigner can enforce a
657                 // only-sign-local-state-for-broadcast once invariant:
658                 commitment_tx: LocalCommitmentTransaction,
659                 local_keys: chan_utils::TxCreationKeys,
660                 feerate_per_kw: u64,
661                 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>,
662         },
663         LatestRemoteCommitmentTXInfo {
664                 unsigned_commitment_tx: Transaction, // TODO: We should actually only need the txid here
665                 htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>,
666                 commitment_number: u64,
667                 their_revocation_point: PublicKey,
668         },
669         PaymentPreimage {
670                 payment_preimage: PaymentPreimage,
671         },
672         CommitmentSecret {
673                 idx: u64,
674                 secret: [u8; 32],
675         },
676         /// Indicates our channel is likely a stale version, we're closing, but this update should
677         /// allow us to spend what is ours if our counterparty broadcasts their latest state.
678         RescueRemoteCommitmentTXInfo {
679                 their_current_per_commitment_point: PublicKey,
680         },
681 }
682
683 impl Writeable for ChannelMonitorUpdateStep {
684         fn write<W: Writer>(&self, w: &mut W) -> Result<(), ::std::io::Error> {
685                 match self {
686                         &ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { ref commitment_tx, ref local_keys, ref feerate_per_kw, ref htlc_outputs } => {
687                                 0u8.write(w)?;
688                                 commitment_tx.write(w)?;
689                                 local_keys.write(w)?;
690                                 feerate_per_kw.write(w)?;
691                                 (htlc_outputs.len() as u64).write(w)?;
692                                 for &(ref output, ref signature, ref source) in htlc_outputs.iter() {
693                                         output.write(w)?;
694                                         signature.write(w)?;
695                                         source.write(w)?;
696                                 }
697                         }
698                         &ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { ref unsigned_commitment_tx, ref htlc_outputs, ref commitment_number, ref their_revocation_point } => {
699                                 1u8.write(w)?;
700                                 unsigned_commitment_tx.write(w)?;
701                                 commitment_number.write(w)?;
702                                 their_revocation_point.write(w)?;
703                                 (htlc_outputs.len() as u64).write(w)?;
704                                 for &(ref output, ref source) in htlc_outputs.iter() {
705                                         output.write(w)?;
706                                         match source {
707                                                 &None => 0u8.write(w)?,
708                                                 &Some(ref s) => {
709                                                         1u8.write(w)?;
710                                                         s.write(w)?;
711                                                 },
712                                         }
713                                 }
714                         },
715                         &ChannelMonitorUpdateStep::PaymentPreimage { ref payment_preimage } => {
716                                 2u8.write(w)?;
717                                 payment_preimage.write(w)?;
718                         },
719                         &ChannelMonitorUpdateStep::CommitmentSecret { ref idx, ref secret } => {
720                                 3u8.write(w)?;
721                                 idx.write(w)?;
722                                 secret.write(w)?;
723                         },
724                         &ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo { ref their_current_per_commitment_point } => {
725                                 4u8.write(w)?;
726                                 their_current_per_commitment_point.write(w)?;
727                         },
728                 }
729                 Ok(())
730         }
731 }
732 impl<R: ::std::io::Read> Readable<R> for ChannelMonitorUpdateStep {
733         fn read(r: &mut R) -> Result<Self, DecodeError> {
734                 match Readable::read(r)? {
735                         0u8 => {
736                                 Ok(ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo {
737                                         commitment_tx: Readable::read(r)?,
738                                         local_keys: Readable::read(r)?,
739                                         feerate_per_kw: Readable::read(r)?,
740                                         htlc_outputs: {
741                                                 let len: u64 = Readable::read(r)?;
742                                                 let mut res = Vec::new();
743                                                 for _ in 0..len {
744                                                         res.push((Readable::read(r)?, Readable::read(r)?, Readable::read(r)?));
745                                                 }
746                                                 res
747                                         },
748                                 })
749                         },
750                         1u8 => {
751                                 Ok(ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo {
752                                         unsigned_commitment_tx: Readable::read(r)?,
753                                         commitment_number: Readable::read(r)?,
754                                         their_revocation_point: Readable::read(r)?,
755                                         htlc_outputs: {
756                                                 let len: u64 = Readable::read(r)?;
757                                                 let mut res = Vec::new();
758                                                 for _ in 0..len {
759                                                         res.push((Readable::read(r)?, <Option<HTLCSource> as Readable<R>>::read(r)?.map(|o| Box::new(o))));
760                                                 }
761                                                 res
762                                         },
763                                 })
764                         },
765                         2u8 => {
766                                 Ok(ChannelMonitorUpdateStep::PaymentPreimage {
767                                         payment_preimage: Readable::read(r)?,
768                                 })
769                         },
770                         3u8 => {
771                                 Ok(ChannelMonitorUpdateStep::CommitmentSecret {
772                                         idx: Readable::read(r)?,
773                                         secret: Readable::read(r)?,
774                                 })
775                         },
776                         4u8 => {
777                                 Ok(ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo {
778                                         their_current_per_commitment_point: Readable::read(r)?,
779                                 })
780                         },
781                         _ => Err(DecodeError::InvalidValue),
782                 }
783         }
784 }
785
786 /// A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
787 /// on-chain transactions to ensure no loss of funds occurs.
788 ///
789 /// You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
790 /// information and are actively monitoring the chain.
791 #[derive(Clone)]
792 pub struct ChannelMonitor<ChanSigner: ChannelKeys> {
793         latest_update_id: u64,
794         commitment_transaction_number_obscure_factor: u64,
795
796         key_storage: Storage<ChanSigner>,
797         their_htlc_base_key: Option<PublicKey>,
798         their_delayed_payment_base_key: Option<PublicKey>,
799         funding_redeemscript: Option<Script>,
800         channel_value_satoshis: Option<u64>,
801         // first is the idx of the first of the two revocation points
802         their_cur_revocation_points: Option<(u64, PublicKey, Option<PublicKey>)>,
803
804         our_to_self_delay: u16,
805         their_to_self_delay: Option<u16>,
806
807         commitment_secrets: CounterpartyCommitmentSecrets,
808         remote_claimable_outpoints: HashMap<Sha256dHash, Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>>,
809         /// We cannot identify HTLC-Success or HTLC-Timeout transactions by themselves on the chain.
810         /// Nor can we figure out their commitment numbers without the commitment transaction they are
811         /// spending. Thus, in order to claim them via revocation key, we track all the remote
812         /// commitment transactions which we find on-chain, mapping them to the commitment number which
813         /// can be used to derive the revocation key and claim the transactions.
814         remote_commitment_txn_on_chain: HashMap<Sha256dHash, (u64, Vec<Script>)>,
815         /// Cache used to make pruning of payment_preimages faster.
816         /// Maps payment_hash values to commitment numbers for remote transactions for non-revoked
817         /// remote transactions (ie should remain pretty small).
818         /// Serialized to disk but should generally not be sent to Watchtowers.
819         remote_hash_commitment_number: HashMap<PaymentHash, u64>,
820
821         // We store two local commitment transactions to avoid any race conditions where we may update
822         // some monitors (potentially on watchtowers) but then fail to update others, resulting in the
823         // various monitors for one channel being out of sync, and us broadcasting a local
824         // transaction for which we have deleted claim information on some watchtowers.
825         prev_local_signed_commitment_tx: Option<LocalSignedTx>,
826         current_local_signed_commitment_tx: Option<LocalSignedTx>,
827
828         // Used just for ChannelManager to make sure it has the latest channel data during
829         // deserialization
830         current_remote_commitment_number: u64,
831
832         payment_preimages: HashMap<PaymentHash, PaymentPreimage>,
833
834         pending_htlcs_updated: Vec<HTLCUpdate>,
835
836         destination_script: Script,
837         // Thanks to data loss protection, we may be able to claim our non-htlc funds
838         // back, this is the script we have to spend from but we need to
839         // scan every commitment transaction for that
840         to_remote_rescue: Option<(Script, SecretKey)>,
841
842         // Used to track claiming requests. If claim tx doesn't confirm before height timer expiration we need to bump
843         // it (RBF or CPFP). If an input has been part of an aggregate tx at first claim try, we need to keep it within
844         // another bumped aggregate tx to comply with RBF rules. We may have multiple claiming txn in the flight for the
845         // same set of outpoints. One of the outpoints may be spent by a transaction not issued by us. That's why at
846         // block connection we scan all inputs and if any of them is among a set of a claiming request we test for set
847         // equality between spending transaction and claim request. If true, it means transaction was one our claiming one
848         // after a security delay of 6 blocks we remove pending claim request. If false, it means transaction wasn't and
849         // we need to regenerate new claim request we reduced set of stil-claimable outpoints.
850         // Key is identifier of the pending claim request, i.e the txid of the initial claiming transaction generated by
851         // us and is immutable until all outpoint of the claimable set are post-anti-reorg-delay solved.
852         // Entry is cache of elements need to generate a bumped claiming transaction (see ClaimTxBumpMaterial)
853         #[cfg(test)] // Used in functional_test to verify sanitization
854         pub pending_claim_requests: HashMap<Sha256dHash, ClaimTxBumpMaterial>,
855         #[cfg(not(test))]
856         pending_claim_requests: HashMap<Sha256dHash, ClaimTxBumpMaterial>,
857
858         // Used to link outpoints claimed in a connected block to a pending claim request.
859         // Key is outpoint than monitor parsing has detected we have keys/scripts to claim
860         // Value is (pending claim request identifier, confirmation_block), identifier
861         // is txid of the initial claiming transaction and is immutable until outpoint is
862         // post-anti-reorg-delay solved, confirmaiton_block is used to erase entry if
863         // block with output gets disconnected.
864         #[cfg(test)] // Used in functional_test to verify sanitization
865         pub claimable_outpoints: HashMap<BitcoinOutPoint, (Sha256dHash, u32)>,
866         #[cfg(not(test))]
867         claimable_outpoints: HashMap<BitcoinOutPoint, (Sha256dHash, u32)>,
868
869         // Used to track onchain events, i.e transactions parts of channels confirmed on chain, on which
870         // we have to take actions once they reach enough confs. Key is a block height timer, i.e we enforce
871         // actions when we receive a block with given height. Actions depend on OnchainEvent type.
872         onchain_events_waiting_threshold_conf: HashMap<u32, Vec<OnchainEvent>>,
873
874         // If we get serialized out and re-read, we need to make sure that the chain monitoring
875         // interface knows about the TXOs that we want to be notified of spends of. We could probably
876         // be smart and derive them from the above storage fields, but its much simpler and more
877         // Obviously Correct (tm) if we just keep track of them explicitly.
878         outputs_to_watch: HashMap<Sha256dHash, Vec<Script>>,
879
880         // We simply modify last_block_hash in Channel's block_connected so that serialization is
881         // consistent but hopefully the users' copy handles block_connected in a consistent way.
882         // (we do *not*, however, update them in insert_combine to ensure any local user copies keep
883         // their last_block_hash from its state and not based on updated copies that didn't run through
884         // the full block_connected).
885         pub(crate) last_block_hash: Sha256dHash,
886         secp_ctx: Secp256k1<secp256k1::All>, //TODO: dedup this a bit...
887         logger: Arc<Logger>,
888 }
889 macro_rules! subtract_high_prio_fee {
890         ($self: ident, $fee_estimator: expr, $value: expr, $predicted_weight: expr, $used_feerate: expr) => {
891                 {
892                         $used_feerate = $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority);
893                         let mut fee = $used_feerate * ($predicted_weight as u64) / 1000;
894                         if $value <= fee {
895                                 $used_feerate = $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Normal);
896                                 fee = $used_feerate * ($predicted_weight as u64) / 1000;
897                                 if $value <= fee {
898                                         $used_feerate = $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::Background);
899                                         fee = $used_feerate * ($predicted_weight as u64) / 1000;
900                                         if $value <= fee {
901                                                 log_error!($self, "Failed to generate an on-chain punishment tx as even low priority fee ({} sat) was more than the entire claim balance ({} sat)",
902                                                         fee, $value);
903                                                 false
904                                         } else {
905                                                 log_warn!($self, "Used low priority fee for on-chain punishment tx as high priority fee was more than the entire claim balance ({} sat)",
906                                                         $value);
907                                                 $value -= fee;
908                                                 true
909                                         }
910                                 } else {
911                                         log_warn!($self, "Used medium priority fee for on-chain punishment tx as high priority fee was more than the entire claim balance ({} sat)",
912                                                 $value);
913                                         $value -= fee;
914                                         true
915                                 }
916                         } else {
917                                 $value -= fee;
918                                 true
919                         }
920                 }
921         }
922 }
923
924 #[cfg(any(test, feature = "fuzztarget"))]
925 /// Used only in testing and fuzztarget to check serialization roundtrips don't change the
926 /// underlying object
927 impl<ChanSigner: ChannelKeys> PartialEq for ChannelMonitor<ChanSigner> {
928         fn eq(&self, other: &Self) -> bool {
929                 if self.latest_update_id != other.latest_update_id ||
930                         self.commitment_transaction_number_obscure_factor != other.commitment_transaction_number_obscure_factor ||
931                         self.key_storage != other.key_storage ||
932                         self.their_htlc_base_key != other.their_htlc_base_key ||
933                         self.their_delayed_payment_base_key != other.their_delayed_payment_base_key ||
934                         self.funding_redeemscript != other.funding_redeemscript ||
935                         self.channel_value_satoshis != other.channel_value_satoshis ||
936                         self.their_cur_revocation_points != other.their_cur_revocation_points ||
937                         self.our_to_self_delay != other.our_to_self_delay ||
938                         self.their_to_self_delay != other.their_to_self_delay ||
939                         self.commitment_secrets != other.commitment_secrets ||
940                         self.remote_claimable_outpoints != other.remote_claimable_outpoints ||
941                         self.remote_commitment_txn_on_chain != other.remote_commitment_txn_on_chain ||
942                         self.remote_hash_commitment_number != other.remote_hash_commitment_number ||
943                         self.prev_local_signed_commitment_tx != other.prev_local_signed_commitment_tx ||
944                         self.current_remote_commitment_number != other.current_remote_commitment_number ||
945                         self.current_local_signed_commitment_tx != other.current_local_signed_commitment_tx ||
946                         self.payment_preimages != other.payment_preimages ||
947                         self.pending_htlcs_updated != other.pending_htlcs_updated ||
948                         self.destination_script != other.destination_script ||
949                         self.to_remote_rescue != other.to_remote_rescue ||
950                         self.pending_claim_requests != other.pending_claim_requests ||
951                         self.claimable_outpoints != other.claimable_outpoints ||
952                         self.onchain_events_waiting_threshold_conf != other.onchain_events_waiting_threshold_conf ||
953                         self.outputs_to_watch != other.outputs_to_watch
954                 {
955                         false
956                 } else {
957                         true
958                 }
959         }
960 }
961
962 impl<ChanSigner: ChannelKeys + Writeable> ChannelMonitor<ChanSigner> {
963         /// Serializes into a vec, with various modes for the exposed pub fns
964         fn write<W: Writer>(&self, writer: &mut W, for_local_storage: bool) -> Result<(), ::std::io::Error> {
965                 //TODO: We still write out all the serialization here manually instead of using the fancy
966                 //serialization framework we have, we should migrate things over to it.
967                 writer.write_all(&[SERIALIZATION_VERSION; 1])?;
968                 writer.write_all(&[MIN_SERIALIZATION_VERSION; 1])?;
969
970                 self.latest_update_id.write(writer)?;
971
972                 // Set in initial Channel-object creation, so should always be set by now:
973                 U48(self.commitment_transaction_number_obscure_factor).write(writer)?;
974
975                 macro_rules! write_option {
976                         ($thing: expr) => {
977                                 match $thing {
978                                         &Some(ref t) => {
979                                                 1u8.write(writer)?;
980                                                 t.write(writer)?;
981                                         },
982                                         &None => 0u8.write(writer)?,
983                                 }
984                         }
985                 }
986
987                 match self.key_storage {
988                         Storage::Local { ref keys, ref funding_key, ref revocation_base_key, ref htlc_base_key, ref delayed_payment_base_key, ref payment_base_key, ref shutdown_pubkey, ref funding_info, ref current_remote_commitment_txid, ref prev_remote_commitment_txid } => {
989                                 writer.write_all(&[0; 1])?;
990                                 keys.write(writer)?;
991                                 writer.write_all(&funding_key[..])?;
992                                 writer.write_all(&revocation_base_key[..])?;
993                                 writer.write_all(&htlc_base_key[..])?;
994                                 writer.write_all(&delayed_payment_base_key[..])?;
995                                 writer.write_all(&payment_base_key[..])?;
996                                 writer.write_all(&shutdown_pubkey.serialize())?;
997                                 match funding_info  {
998                                         &Some((ref outpoint, ref script)) => {
999                                                 writer.write_all(&outpoint.txid[..])?;
1000                                                 writer.write_all(&byte_utils::be16_to_array(outpoint.index))?;
1001                                                 script.write(writer)?;
1002                                         },
1003                                         &None => {
1004                                                 debug_assert!(false, "Try to serialize a useless Local monitor !");
1005                                         },
1006                                 }
1007                                 current_remote_commitment_txid.write(writer)?;
1008                                 prev_remote_commitment_txid.write(writer)?;
1009                         },
1010                         Storage::Watchtower { .. } => unimplemented!(),
1011                 }
1012
1013                 writer.write_all(&self.their_htlc_base_key.as_ref().unwrap().serialize())?;
1014                 writer.write_all(&self.their_delayed_payment_base_key.as_ref().unwrap().serialize())?;
1015                 self.funding_redeemscript.as_ref().unwrap().write(writer)?;
1016                 self.channel_value_satoshis.unwrap().write(writer)?;
1017
1018                 match self.their_cur_revocation_points {
1019                         Some((idx, pubkey, second_option)) => {
1020                                 writer.write_all(&byte_utils::be48_to_array(idx))?;
1021                                 writer.write_all(&pubkey.serialize())?;
1022                                 match second_option {
1023                                         Some(second_pubkey) => {
1024                                                 writer.write_all(&second_pubkey.serialize())?;
1025                                         },
1026                                         None => {
1027                                                 writer.write_all(&[0; 33])?;
1028                                         },
1029                                 }
1030                         },
1031                         None => {
1032                                 writer.write_all(&byte_utils::be48_to_array(0))?;
1033                         },
1034                 }
1035
1036                 writer.write_all(&byte_utils::be16_to_array(self.our_to_self_delay))?;
1037                 writer.write_all(&byte_utils::be16_to_array(self.their_to_self_delay.unwrap()))?;
1038
1039                 self.commitment_secrets.write(writer)?;
1040
1041                 macro_rules! serialize_htlc_in_commitment {
1042                         ($htlc_output: expr) => {
1043                                 writer.write_all(&[$htlc_output.offered as u8; 1])?;
1044                                 writer.write_all(&byte_utils::be64_to_array($htlc_output.amount_msat))?;
1045                                 writer.write_all(&byte_utils::be32_to_array($htlc_output.cltv_expiry))?;
1046                                 writer.write_all(&$htlc_output.payment_hash.0[..])?;
1047                                 $htlc_output.transaction_output_index.write(writer)?;
1048                         }
1049                 }
1050
1051                 writer.write_all(&byte_utils::be64_to_array(self.remote_claimable_outpoints.len() as u64))?;
1052                 for (ref txid, ref htlc_infos) in self.remote_claimable_outpoints.iter() {
1053                         writer.write_all(&txid[..])?;
1054                         writer.write_all(&byte_utils::be64_to_array(htlc_infos.len() as u64))?;
1055                         for &(ref htlc_output, ref htlc_source) in htlc_infos.iter() {
1056                                 serialize_htlc_in_commitment!(htlc_output);
1057                                 write_option!(htlc_source);
1058                         }
1059                 }
1060
1061                 writer.write_all(&byte_utils::be64_to_array(self.remote_commitment_txn_on_chain.len() as u64))?;
1062                 for (ref txid, &(commitment_number, ref txouts)) in self.remote_commitment_txn_on_chain.iter() {
1063                         writer.write_all(&txid[..])?;
1064                         writer.write_all(&byte_utils::be48_to_array(commitment_number))?;
1065                         (txouts.len() as u64).write(writer)?;
1066                         for script in txouts.iter() {
1067                                 script.write(writer)?;
1068                         }
1069                 }
1070
1071                 if for_local_storage {
1072                         writer.write_all(&byte_utils::be64_to_array(self.remote_hash_commitment_number.len() as u64))?;
1073                         for (ref payment_hash, commitment_number) in self.remote_hash_commitment_number.iter() {
1074                                 writer.write_all(&payment_hash.0[..])?;
1075                                 writer.write_all(&byte_utils::be48_to_array(*commitment_number))?;
1076                         }
1077                 } else {
1078                         writer.write_all(&byte_utils::be64_to_array(0))?;
1079                 }
1080
1081                 macro_rules! serialize_local_tx {
1082                         ($local_tx: expr) => {
1083                                 $local_tx.tx.write(writer)?;
1084                                 writer.write_all(&$local_tx.revocation_key.serialize())?;
1085                                 writer.write_all(&$local_tx.a_htlc_key.serialize())?;
1086                                 writer.write_all(&$local_tx.b_htlc_key.serialize())?;
1087                                 writer.write_all(&$local_tx.delayed_payment_key.serialize())?;
1088                                 writer.write_all(&$local_tx.per_commitment_point.serialize())?;
1089
1090                                 writer.write_all(&byte_utils::be64_to_array($local_tx.feerate_per_kw))?;
1091                                 writer.write_all(&byte_utils::be64_to_array($local_tx.htlc_outputs.len() as u64))?;
1092                                 for &(ref htlc_output, ref sig, ref htlc_source) in $local_tx.htlc_outputs.iter() {
1093                                         serialize_htlc_in_commitment!(htlc_output);
1094                                         if let &Some(ref their_sig) = sig {
1095                                                 1u8.write(writer)?;
1096                                                 writer.write_all(&their_sig.serialize_compact())?;
1097                                         } else {
1098                                                 0u8.write(writer)?;
1099                                         }
1100                                         write_option!(htlc_source);
1101                                 }
1102                         }
1103                 }
1104
1105                 if let Some(ref prev_local_tx) = self.prev_local_signed_commitment_tx {
1106                         writer.write_all(&[1; 1])?;
1107                         serialize_local_tx!(prev_local_tx);
1108                 } else {
1109                         writer.write_all(&[0; 1])?;
1110                 }
1111
1112                 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
1113                         writer.write_all(&[1; 1])?;
1114                         serialize_local_tx!(cur_local_tx);
1115                 } else {
1116                         writer.write_all(&[0; 1])?;
1117                 }
1118
1119                 if for_local_storage {
1120                         writer.write_all(&byte_utils::be48_to_array(self.current_remote_commitment_number))?;
1121                 } else {
1122                         writer.write_all(&byte_utils::be48_to_array(0))?;
1123                 }
1124
1125                 writer.write_all(&byte_utils::be64_to_array(self.payment_preimages.len() as u64))?;
1126                 for payment_preimage in self.payment_preimages.values() {
1127                         writer.write_all(&payment_preimage.0[..])?;
1128                 }
1129
1130                 writer.write_all(&byte_utils::be64_to_array(self.pending_htlcs_updated.len() as u64))?;
1131                 for data in self.pending_htlcs_updated.iter() {
1132                         data.write(writer)?;
1133                 }
1134
1135                 self.last_block_hash.write(writer)?;
1136                 self.destination_script.write(writer)?;
1137                 if let Some((ref to_remote_script, ref local_key)) = self.to_remote_rescue {
1138                         writer.write_all(&[1; 1])?;
1139                         to_remote_script.write(writer)?;
1140                         local_key.write(writer)?;
1141                 } else {
1142                         writer.write_all(&[0; 1])?;
1143                 }
1144
1145                 writer.write_all(&byte_utils::be64_to_array(self.pending_claim_requests.len() as u64))?;
1146                 for (ref ancestor_claim_txid, claim_tx_data) in self.pending_claim_requests.iter() {
1147                         ancestor_claim_txid.write(writer)?;
1148                         claim_tx_data.write(writer)?;
1149                 }
1150
1151                 writer.write_all(&byte_utils::be64_to_array(self.claimable_outpoints.len() as u64))?;
1152                 for (ref outp, ref claim_and_height) in self.claimable_outpoints.iter() {
1153                         outp.write(writer)?;
1154                         claim_and_height.0.write(writer)?;
1155                         claim_and_height.1.write(writer)?;
1156                 }
1157
1158                 writer.write_all(&byte_utils::be64_to_array(self.onchain_events_waiting_threshold_conf.len() as u64))?;
1159                 for (ref target, ref events) in self.onchain_events_waiting_threshold_conf.iter() {
1160                         writer.write_all(&byte_utils::be32_to_array(**target))?;
1161                         writer.write_all(&byte_utils::be64_to_array(events.len() as u64))?;
1162                         for ev in events.iter() {
1163                                 match *ev {
1164                                         OnchainEvent::Claim { ref claim_request } => {
1165                                                 writer.write_all(&[0; 1])?;
1166                                                 claim_request.write(writer)?;
1167                                         },
1168                                         OnchainEvent::HTLCUpdate { ref htlc_update } => {
1169                                                 writer.write_all(&[1; 1])?;
1170                                                 htlc_update.0.write(writer)?;
1171                                                 htlc_update.1.write(writer)?;
1172                                         },
1173                                         OnchainEvent::ContentiousOutpoint { ref outpoint, ref input_material } => {
1174                                                 writer.write_all(&[2; 1])?;
1175                                                 outpoint.write(writer)?;
1176                                                 input_material.write(writer)?;
1177                                         }
1178                                 }
1179                         }
1180                 }
1181
1182                 (self.outputs_to_watch.len() as u64).write(writer)?;
1183                 for (txid, output_scripts) in self.outputs_to_watch.iter() {
1184                         txid.write(writer)?;
1185                         (output_scripts.len() as u64).write(writer)?;
1186                         for script in output_scripts.iter() {
1187                                 script.write(writer)?;
1188                         }
1189                 }
1190
1191                 Ok(())
1192         }
1193
1194         /// Writes this monitor into the given writer, suitable for writing to disk.
1195         ///
1196         /// Note that the deserializer is only implemented for (Sha256dHash, ChannelMonitor), which
1197         /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
1198         /// the "reorg path" (ie not just starting at the same height but starting at the highest
1199         /// common block that appears on your best chain as well as on the chain which contains the
1200         /// last block hash returned) upon deserializing the object!
1201         pub fn write_for_disk<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
1202                 self.write(writer, true)
1203         }
1204
1205         /// Encodes this monitor into the given writer, suitable for sending to a remote watchtower
1206         ///
1207         /// Note that the deserializer is only implemented for (Sha256dHash, ChannelMonitor), which
1208         /// tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
1209         /// the "reorg path" (ie not just starting at the same height but starting at the highest
1210         /// common block that appears on your best chain as well as on the chain which contains the
1211         /// last block hash returned) upon deserializing the object!
1212         pub fn write_for_watchtower<W: Writer>(&self, writer: &mut W) -> Result<(), ::std::io::Error> {
1213                 self.write(writer, false)
1214         }
1215 }
1216
1217 impl<ChanSigner: ChannelKeys> ChannelMonitor<ChanSigner> {
1218         pub(super) fn new(keys: ChanSigner, shutdown_pubkey: &PublicKey,
1219                         our_to_self_delay: u16, destination_script: &Script, funding_info: (OutPoint, Script),
1220                         their_htlc_base_key: &PublicKey, their_delayed_payment_base_key: &PublicKey,
1221                         their_to_self_delay: u16, funding_redeemscript: Script, channel_value_satoshis: u64,
1222                         commitment_transaction_number_obscure_factor: u64,
1223                         logger: Arc<Logger>) -> ChannelMonitor<ChanSigner> {
1224
1225                 assert!(commitment_transaction_number_obscure_factor <= (1 << 48));
1226                 let funding_key = keys.funding_key().clone();
1227                 let revocation_base_key = keys.revocation_base_key().clone();
1228                 let htlc_base_key = keys.htlc_base_key().clone();
1229                 let delayed_payment_base_key = keys.delayed_payment_base_key().clone();
1230                 let payment_base_key = keys.payment_base_key().clone();
1231                 ChannelMonitor {
1232                         latest_update_id: 0,
1233                         commitment_transaction_number_obscure_factor,
1234
1235                         key_storage: Storage::Local {
1236                                 keys,
1237                                 funding_key,
1238                                 revocation_base_key,
1239                                 htlc_base_key,
1240                                 delayed_payment_base_key,
1241                                 payment_base_key,
1242                                 shutdown_pubkey: shutdown_pubkey.clone(),
1243                                 funding_info: Some(funding_info),
1244                                 current_remote_commitment_txid: None,
1245                                 prev_remote_commitment_txid: None,
1246                         },
1247                         their_htlc_base_key: Some(their_htlc_base_key.clone()),
1248                         their_delayed_payment_base_key: Some(their_delayed_payment_base_key.clone()),
1249                         funding_redeemscript: Some(funding_redeemscript),
1250                         channel_value_satoshis: Some(channel_value_satoshis),
1251                         their_cur_revocation_points: None,
1252
1253                         our_to_self_delay: our_to_self_delay,
1254                         their_to_self_delay: Some(their_to_self_delay),
1255
1256                         commitment_secrets: CounterpartyCommitmentSecrets::new(),
1257                         remote_claimable_outpoints: HashMap::new(),
1258                         remote_commitment_txn_on_chain: HashMap::new(),
1259                         remote_hash_commitment_number: HashMap::new(),
1260
1261                         prev_local_signed_commitment_tx: None,
1262                         current_local_signed_commitment_tx: None,
1263                         current_remote_commitment_number: 1 << 48,
1264
1265                         payment_preimages: HashMap::new(),
1266                         pending_htlcs_updated: Vec::new(),
1267
1268                         destination_script: destination_script.clone(),
1269                         to_remote_rescue: None,
1270
1271                         pending_claim_requests: HashMap::new(),
1272
1273                         claimable_outpoints: HashMap::new(),
1274
1275                         onchain_events_waiting_threshold_conf: HashMap::new(),
1276                         outputs_to_watch: HashMap::new(),
1277
1278                         last_block_hash: Default::default(),
1279                         secp_ctx: Secp256k1::new(),
1280                         logger,
1281                 }
1282         }
1283
1284         fn get_witnesses_weight(inputs: &[InputDescriptors]) -> usize {
1285                 let mut tx_weight = 2; // count segwit flags
1286                 for inp in inputs {
1287                         // We use expected weight (and not actual) as signatures and time lock delays may vary
1288                         tx_weight +=  match inp {
1289                                 // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
1290                                 &InputDescriptors::RevokedOfferedHTLC => {
1291                                         1 + 1 + 73 + 1 + 33 + 1 + 133
1292                                 },
1293                                 // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
1294                                 &InputDescriptors::RevokedReceivedHTLC => {
1295                                         1 + 1 + 73 + 1 + 33 + 1 + 139
1296                                 },
1297                                 // number_of_witness_elements + sig_length + remotehtlc_sig  + preimage_length + preimage + witness_script_length + witness_script
1298                                 &InputDescriptors::OfferedHTLC => {
1299                                         1 + 1 + 73 + 1 + 32 + 1 + 133
1300                                 },
1301                                 // number_of_witness_elements + sig_length + revocation_sig + pubkey_length + revocationpubkey + witness_script_length + witness_script
1302                                 &InputDescriptors::ReceivedHTLC => {
1303                                         1 + 1 + 73 + 1 + 1 + 1 + 139
1304                                 },
1305                                 // number_of_witness_elements + sig_length + revocation_sig + true_length + op_true + witness_script_length + witness_script
1306                                 &InputDescriptors::RevokedOutput => {
1307                                         1 + 1 + 73 + 1 + 1 + 1 + 77
1308                                 },
1309                         };
1310                 }
1311                 tx_weight
1312         }
1313
1314         fn get_height_timer(current_height: u32, timelock_expiration: u32) -> u32 {
1315                 if timelock_expiration <= current_height || timelock_expiration - current_height <= 3 {
1316                         return current_height + 1
1317                 } else if timelock_expiration - current_height <= 15 {
1318                         return current_height + 3
1319                 }
1320                 current_height + 15
1321         }
1322
1323         /// Inserts a revocation secret into this channel monitor. Prunes old preimages if neither
1324         /// needed by local commitment transactions HTCLs nor by remote ones. Unless we haven't already seen remote
1325         /// commitment transaction's secret, they are de facto pruned (we can use revocation key).
1326         pub(super) fn provide_secret(&mut self, idx: u64, secret: [u8; 32]) -> Result<(), MonitorUpdateError> {
1327                 if let Err(()) = self.commitment_secrets.provide_secret(idx, secret) {
1328                         return Err(MonitorUpdateError("Previous secret did not match new one"));
1329                 }
1330
1331                 // Prune HTLCs from the previous remote commitment tx so we don't generate failure/fulfill
1332                 // events for now-revoked/fulfilled HTLCs.
1333                 // TODO: We should probably consider whether we're really getting the next secret here.
1334                 if let Storage::Local { ref mut prev_remote_commitment_txid, .. } = self.key_storage {
1335                         if let Some(txid) = prev_remote_commitment_txid.take() {
1336                                 for &mut (_, ref mut source) in self.remote_claimable_outpoints.get_mut(&txid).unwrap() {
1337                                         *source = None;
1338                                 }
1339                         }
1340                 }
1341
1342                 if !self.payment_preimages.is_empty() {
1343                         let local_signed_commitment_tx = self.current_local_signed_commitment_tx.as_ref().expect("Channel needs at least an initial commitment tx !");
1344                         let prev_local_signed_commitment_tx = self.prev_local_signed_commitment_tx.as_ref();
1345                         let min_idx = self.get_min_seen_secret();
1346                         let remote_hash_commitment_number = &mut self.remote_hash_commitment_number;
1347
1348                         self.payment_preimages.retain(|&k, _| {
1349                                 for &(ref htlc, _, _) in &local_signed_commitment_tx.htlc_outputs {
1350                                         if k == htlc.payment_hash {
1351                                                 return true
1352                                         }
1353                                 }
1354                                 if let Some(prev_local_commitment_tx) = prev_local_signed_commitment_tx {
1355                                         for &(ref htlc, _, _) in prev_local_commitment_tx.htlc_outputs.iter() {
1356                                                 if k == htlc.payment_hash {
1357                                                         return true
1358                                                 }
1359                                         }
1360                                 }
1361                                 let contains = if let Some(cn) = remote_hash_commitment_number.get(&k) {
1362                                         if *cn < min_idx {
1363                                                 return true
1364                                         }
1365                                         true
1366                                 } else { false };
1367                                 if contains {
1368                                         remote_hash_commitment_number.remove(&k);
1369                                 }
1370                                 false
1371                         });
1372                 }
1373
1374                 Ok(())
1375         }
1376
1377         /// Informs this monitor of the latest remote (ie non-broadcastable) commitment transaction.
1378         /// The monitor watches for it to be broadcasted and then uses the HTLC information (and
1379         /// possibly future revocation/preimage information) to claim outputs where possible.
1380         /// We cache also the mapping hash:commitment number to lighten pruning of old preimages by watchtowers.
1381         pub(super) fn provide_latest_remote_commitment_tx_info(&mut self, unsigned_commitment_tx: &Transaction, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Box<HTLCSource>>)>, commitment_number: u64, their_revocation_point: PublicKey) {
1382                 // TODO: Encrypt the htlc_outputs data with the single-hash of the commitment transaction
1383                 // so that a remote monitor doesn't learn anything unless there is a malicious close.
1384                 // (only maybe, sadly we cant do the same for local info, as we need to be aware of
1385                 // timeouts)
1386                 for &(ref htlc, _) in &htlc_outputs {
1387                         self.remote_hash_commitment_number.insert(htlc.payment_hash, commitment_number);
1388                 }
1389
1390                 let new_txid = unsigned_commitment_tx.txid();
1391                 log_trace!(self, "Tracking new remote commitment transaction with txid {} at commitment number {} with {} HTLC outputs", new_txid, commitment_number, htlc_outputs.len());
1392                 log_trace!(self, "New potential remote commitment transaction: {}", encode::serialize_hex(unsigned_commitment_tx));
1393                 if let Storage::Local { ref mut current_remote_commitment_txid, ref mut prev_remote_commitment_txid, .. } = self.key_storage {
1394                         *prev_remote_commitment_txid = current_remote_commitment_txid.take();
1395                         *current_remote_commitment_txid = Some(new_txid);
1396                 }
1397                 self.remote_claimable_outpoints.insert(new_txid, htlc_outputs);
1398                 self.current_remote_commitment_number = commitment_number;
1399                 //TODO: Merge this into the other per-remote-transaction output storage stuff
1400                 match self.their_cur_revocation_points {
1401                         Some(old_points) => {
1402                                 if old_points.0 == commitment_number + 1 {
1403                                         self.their_cur_revocation_points = Some((old_points.0, old_points.1, Some(their_revocation_point)));
1404                                 } else if old_points.0 == commitment_number + 2 {
1405                                         if let Some(old_second_point) = old_points.2 {
1406                                                 self.their_cur_revocation_points = Some((old_points.0 - 1, old_second_point, Some(their_revocation_point)));
1407                                         } else {
1408                                                 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1409                                         }
1410                                 } else {
1411                                         self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1412                                 }
1413                         },
1414                         None => {
1415                                 self.their_cur_revocation_points = Some((commitment_number, their_revocation_point, None));
1416                         }
1417                 }
1418         }
1419
1420         pub(super) fn provide_rescue_remote_commitment_tx_info(&mut self, their_revocation_point: PublicKey) {
1421                 match self.key_storage {
1422                         Storage::Local { ref payment_base_key, ref keys, .. } => {
1423                                 if let Ok(payment_key) = chan_utils::derive_public_key(&self.secp_ctx, &their_revocation_point, &keys.pubkeys().payment_basepoint) {
1424                                         let to_remote_script =  Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0)
1425                                                 .push_slice(&Hash160::hash(&payment_key.serialize())[..])
1426                                                 .into_script();
1427                                         if let Ok(to_remote_key) = chan_utils::derive_private_key(&self.secp_ctx, &their_revocation_point, &payment_base_key) {
1428                                                 self.to_remote_rescue = Some((to_remote_script, to_remote_key));
1429                                         }
1430                                 }
1431                         },
1432                         Storage::Watchtower { .. } => {}
1433                 }
1434         }
1435
1436         /// Informs this monitor of the latest local (ie broadcastable) commitment transaction. The
1437         /// monitor watches for timeouts and may broadcast it if we approach such a timeout. Thus, it
1438         /// is important that any clones of this channel monitor (including remote clones) by kept
1439         /// up-to-date as our local commitment transaction is updated.
1440         /// Panics if set_their_to_self_delay has never been called.
1441         pub(super) fn provide_latest_local_commitment_tx_info(&mut self, commitment_tx: LocalCommitmentTransaction, local_keys: chan_utils::TxCreationKeys, feerate_per_kw: u64, htlc_outputs: Vec<(HTLCOutputInCommitment, Option<Signature>, Option<HTLCSource>)>) -> Result<(), MonitorUpdateError> {
1442                 if self.their_to_self_delay.is_none() {
1443                         return Err(MonitorUpdateError("Got a local commitment tx info update before we'd set basic information about the channel"));
1444                 }
1445                 self.prev_local_signed_commitment_tx = self.current_local_signed_commitment_tx.take();
1446                 self.current_local_signed_commitment_tx = Some(LocalSignedTx {
1447                         txid: commitment_tx.txid(),
1448                         tx: commitment_tx,
1449                         revocation_key: local_keys.revocation_key,
1450                         a_htlc_key: local_keys.a_htlc_key,
1451                         b_htlc_key: local_keys.b_htlc_key,
1452                         delayed_payment_key: local_keys.a_delayed_payment_key,
1453                         per_commitment_point: local_keys.per_commitment_point,
1454                         feerate_per_kw,
1455                         htlc_outputs,
1456                 });
1457                 Ok(())
1458         }
1459
1460         /// Provides a payment_hash->payment_preimage mapping. Will be automatically pruned when all
1461         /// commitment_tx_infos which contain the payment hash have been revoked.
1462         pub(super) fn provide_payment_preimage(&mut self, payment_hash: &PaymentHash, payment_preimage: &PaymentPreimage) {
1463                 self.payment_preimages.insert(payment_hash.clone(), payment_preimage.clone());
1464         }
1465
1466         /// Used in Channel to cheat wrt the update_ids since it plays games, will be removed soon!
1467         pub(super) fn update_monitor_ooo(&mut self, mut updates: ChannelMonitorUpdate) -> Result<(), MonitorUpdateError> {
1468                 for update in updates.updates.drain(..) {
1469                         match update {
1470                                 ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { commitment_tx, local_keys, feerate_per_kw, htlc_outputs } =>
1471                                         self.provide_latest_local_commitment_tx_info(commitment_tx, local_keys, feerate_per_kw, htlc_outputs)?,
1472                                 ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point } =>
1473                                         self.provide_latest_remote_commitment_tx_info(&unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point),
1474                                 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } =>
1475                                         self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage),
1476                                 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } =>
1477                                         self.provide_secret(idx, secret)?,
1478                                 ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo { their_current_per_commitment_point } =>
1479                                         self.provide_rescue_remote_commitment_tx_info(their_current_per_commitment_point),
1480                         }
1481                 }
1482                 self.latest_update_id = updates.update_id;
1483                 Ok(())
1484         }
1485
1486         /// Updates a ChannelMonitor on the basis of some new information provided by the Channel
1487         /// itself.
1488         ///
1489         /// panics if the given update is not the next update by update_id.
1490         pub fn update_monitor(&mut self, mut updates: ChannelMonitorUpdate) -> Result<(), MonitorUpdateError> {
1491                 if self.latest_update_id + 1 != updates.update_id {
1492                         panic!("Attempted to apply ChannelMonitorUpdates out of order, check the update_id before passing an update to update_monitor!");
1493                 }
1494                 for update in updates.updates.drain(..) {
1495                         match update {
1496                                 ChannelMonitorUpdateStep::LatestLocalCommitmentTXInfo { commitment_tx, local_keys, feerate_per_kw, htlc_outputs } =>
1497                                         self.provide_latest_local_commitment_tx_info(commitment_tx, local_keys, feerate_per_kw, htlc_outputs)?,
1498                                 ChannelMonitorUpdateStep::LatestRemoteCommitmentTXInfo { unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point } =>
1499                                         self.provide_latest_remote_commitment_tx_info(&unsigned_commitment_tx, htlc_outputs, commitment_number, their_revocation_point),
1500                                 ChannelMonitorUpdateStep::PaymentPreimage { payment_preimage } =>
1501                                         self.provide_payment_preimage(&PaymentHash(Sha256::hash(&payment_preimage.0[..]).into_inner()), &payment_preimage),
1502                                 ChannelMonitorUpdateStep::CommitmentSecret { idx, secret } =>
1503                                         self.provide_secret(idx, secret)?,
1504                                 ChannelMonitorUpdateStep::RescueRemoteCommitmentTXInfo { their_current_per_commitment_point } =>
1505                                         self.provide_rescue_remote_commitment_tx_info(their_current_per_commitment_point),
1506                         }
1507                 }
1508                 self.latest_update_id = updates.update_id;
1509                 Ok(())
1510         }
1511
1512         /// Combines this ChannelMonitor with the information contained in the other ChannelMonitor.
1513         /// After a successful call this ChannelMonitor is up-to-date and is safe to use to monitor the
1514         /// chain for new blocks/transactions.
1515         pub fn insert_combine(&mut self, mut other: ChannelMonitor<ChanSigner>) -> Result<(), MonitorUpdateError> {
1516                 match self.key_storage {
1517                         Storage::Local { ref funding_info, .. } => {
1518                                 if funding_info.is_none() { return Err(MonitorUpdateError("Try to combine a Local monitor without funding_info")); }
1519                                 let our_funding_info = funding_info;
1520                                 if let Storage::Local { ref funding_info, .. } = other.key_storage {
1521                                         if funding_info.is_none() { return Err(MonitorUpdateError("Try to combine a Local monitor without funding_info")); }
1522                                         // We should be able to compare the entire funding_txo, but in fuzztarget it's trivially
1523                                         // easy to collide the funding_txo hash and have a different scriptPubKey.
1524                                         if funding_info.as_ref().unwrap().0 != our_funding_info.as_ref().unwrap().0 {
1525                                                 return Err(MonitorUpdateError("Funding transaction outputs are not identical!"));
1526                                         }
1527                                 } else {
1528                                         return Err(MonitorUpdateError("Try to combine a Local monitor with a Watchtower one !"));
1529                                 }
1530                         },
1531                         Storage::Watchtower { .. } => {
1532                                 if let Storage::Watchtower { .. } = other.key_storage {
1533                                         unimplemented!();
1534                                 } else {
1535                                         return Err(MonitorUpdateError("Try to combine a Watchtower monitor with a Local one !"));
1536                                 }
1537                         },
1538                 }
1539                 let other_min_secret = other.get_min_seen_secret();
1540                 let our_min_secret = self.get_min_seen_secret();
1541                 if our_min_secret > other_min_secret {
1542                         self.provide_secret(other_min_secret, other.get_secret(other_min_secret).unwrap())?;
1543                 }
1544                 if let Some(ref local_tx) = self.current_local_signed_commitment_tx {
1545                         if let Some(ref other_local_tx) = other.current_local_signed_commitment_tx {
1546                                 let our_commitment_number = 0xffffffffffff - ((((local_tx.tx.without_valid_witness().input[0].sequence as u64 & 0xffffff) << 3*8) | (local_tx.tx.without_valid_witness().lock_time as u64 & 0xffffff)) ^ self.commitment_transaction_number_obscure_factor);
1547                                 let other_commitment_number = 0xffffffffffff - ((((other_local_tx.tx.without_valid_witness().input[0].sequence as u64 & 0xffffff) << 3*8) | (other_local_tx.tx.without_valid_witness().lock_time as u64 & 0xffffff)) ^ other.commitment_transaction_number_obscure_factor);
1548                                 if our_commitment_number >= other_commitment_number {
1549                                         self.key_storage = other.key_storage;
1550                                 }
1551                         }
1552                 }
1553                 // TODO: We should use current_remote_commitment_number and the commitment number out of
1554                 // local transactions to decide how to merge
1555                 if our_min_secret >= other_min_secret {
1556                         self.their_cur_revocation_points = other.their_cur_revocation_points;
1557                         for (txid, htlcs) in other.remote_claimable_outpoints.drain() {
1558                                 self.remote_claimable_outpoints.insert(txid, htlcs);
1559                         }
1560                         if let Some(local_tx) = other.prev_local_signed_commitment_tx {
1561                                 self.prev_local_signed_commitment_tx = Some(local_tx);
1562                         }
1563                         if let Some(local_tx) = other.current_local_signed_commitment_tx {
1564                                 self.current_local_signed_commitment_tx = Some(local_tx);
1565                         }
1566                         self.payment_preimages = other.payment_preimages;
1567                         self.to_remote_rescue = other.to_remote_rescue;
1568                 }
1569
1570                 self.current_remote_commitment_number = cmp::min(self.current_remote_commitment_number, other.current_remote_commitment_number);
1571                 Ok(())
1572         }
1573
1574         /// Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
1575         /// ChannelMonitor.
1576         pub fn get_latest_update_id(&self) -> u64 {
1577                 self.latest_update_id
1578         }
1579
1580         /// Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
1581         pub fn get_funding_txo(&self) -> Option<OutPoint> {
1582                 match self.key_storage {
1583                         Storage::Local { ref funding_info, .. } => {
1584                                 match funding_info {
1585                                         &Some((outpoint, _)) => Some(outpoint),
1586                                         &None => None
1587                                 }
1588                         },
1589                         Storage::Watchtower { .. } => {
1590                                 return None;
1591                         }
1592                 }
1593         }
1594
1595         /// Gets a list of txids, with their output scripts (in the order they appear in the
1596         /// transaction), which we must learn about spends of via block_connected().
1597         pub fn get_outputs_to_watch(&self) -> &HashMap<Sha256dHash, Vec<Script>> {
1598                 &self.outputs_to_watch
1599         }
1600
1601         /// Gets the sets of all outpoints which this ChannelMonitor expects to hear about spends of.
1602         /// Generally useful when deserializing as during normal operation the return values of
1603         /// block_connected are sufficient to ensure all relevant outpoints are being monitored (note
1604         /// that the get_funding_txo outpoint and transaction must also be monitored for!).
1605         pub fn get_monitored_outpoints(&self) -> Vec<(Sha256dHash, u32, &Script)> {
1606                 let mut res = Vec::with_capacity(self.remote_commitment_txn_on_chain.len() * 2);
1607                 for (ref txid, &(_, ref outputs)) in self.remote_commitment_txn_on_chain.iter() {
1608                         for (idx, output) in outputs.iter().enumerate() {
1609                                 res.push(((*txid).clone(), idx as u32, output));
1610                         }
1611                 }
1612                 res
1613         }
1614
1615         /// Get the list of HTLCs who's status has been updated on chain. This should be called by
1616         /// ChannelManager via ManyChannelMonitor::get_and_clear_pending_htlcs_updated().
1617         pub fn get_and_clear_pending_htlcs_updated(&mut self) -> Vec<HTLCUpdate> {
1618                 let mut ret = Vec::new();
1619                 mem::swap(&mut ret, &mut self.pending_htlcs_updated);
1620                 ret
1621         }
1622
1623         /// Can only fail if idx is < get_min_seen_secret
1624         pub(super) fn get_secret(&self, idx: u64) -> Option<[u8; 32]> {
1625                 self.commitment_secrets.get_secret(idx)
1626         }
1627
1628         pub(super) fn get_min_seen_secret(&self) -> u64 {
1629                 self.commitment_secrets.get_min_seen_secret()
1630         }
1631
1632         pub(super) fn get_cur_remote_commitment_number(&self) -> u64 {
1633                 self.current_remote_commitment_number
1634         }
1635
1636         pub(super) fn get_cur_local_commitment_number(&self) -> u64 {
1637                 if let &Some(ref local_tx) = &self.current_local_signed_commitment_tx {
1638                         0xffff_ffff_ffff - ((((local_tx.tx.without_valid_witness().input[0].sequence as u64 & 0xffffff) << 3*8) | (local_tx.tx.without_valid_witness().lock_time as u64 & 0xffffff)) ^ self.commitment_transaction_number_obscure_factor)
1639                 } else { 0xffff_ffff_ffff }
1640         }
1641
1642         /// Attempts to claim a remote commitment transaction's outputs using the revocation key and
1643         /// data in remote_claimable_outpoints. Will directly claim any HTLC outputs which expire at a
1644         /// height > height + CLTV_SHARED_CLAIM_BUFFER. In any case, will install monitoring for
1645         /// HTLC-Success/HTLC-Timeout transactions.
1646         /// Return updates for HTLC pending in the channel and failed automatically by the broadcast of
1647         /// revoked remote commitment tx
1648         fn check_spend_remote_transaction(&mut self, tx: &Transaction, height: u32, fee_estimator: &FeeEstimator) -> (Vec<Transaction>, (Sha256dHash, Vec<TxOut>), Vec<SpendableOutputDescriptor>) {
1649                 // Most secp and related errors trying to create keys means we have no hope of constructing
1650                 // a spend transaction...so we return no transactions to broadcast
1651                 let mut txn_to_broadcast = Vec::new();
1652                 let mut watch_outputs = Vec::new();
1653                 let mut spendable_outputs = Vec::new();
1654
1655                 let commitment_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
1656                 let per_commitment_option = self.remote_claimable_outpoints.get(&commitment_txid);
1657
1658                 macro_rules! ignore_error {
1659                         ( $thing : expr ) => {
1660                                 match $thing {
1661                                         Ok(a) => a,
1662                                         Err(_) => return (txn_to_broadcast, (commitment_txid, watch_outputs), spendable_outputs)
1663                                 }
1664                         };
1665                 }
1666
1667                 let commitment_number = 0xffffffffffff - ((((tx.input[0].sequence as u64 & 0xffffff) << 3*8) | (tx.lock_time as u64 & 0xffffff)) ^ self.commitment_transaction_number_obscure_factor);
1668                 if commitment_number >= self.get_min_seen_secret() {
1669                         let secret = self.get_secret(commitment_number).unwrap();
1670                         let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
1671                         let (revocation_pubkey, b_htlc_key, local_payment_key) = match self.key_storage {
1672                                 Storage::Local { ref keys, ref payment_base_key, .. } => {
1673                                         let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1674                                         (ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &keys.pubkeys().revocation_basepoint)),
1675                                         ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &keys.pubkeys().htlc_basepoint)),
1676                                         Some(ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, &per_commitment_point, &payment_base_key))))
1677                                 },
1678                                 Storage::Watchtower { ref revocation_base_key, ref htlc_base_key, .. } => {
1679                                         let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
1680                                         (ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &revocation_base_key)),
1681                                         ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &htlc_base_key)),
1682                                         None)
1683                                 },
1684                         };
1685                         let delayed_key = ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &self.their_delayed_payment_base_key.unwrap()));
1686                         let a_htlc_key = match self.their_htlc_base_key {
1687                                 None => return (txn_to_broadcast, (commitment_txid, watch_outputs), spendable_outputs),
1688                                 Some(their_htlc_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key), &their_htlc_base_key)),
1689                         };
1690
1691                         let revokeable_redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.our_to_self_delay, &delayed_key);
1692                         let revokeable_p2wsh = revokeable_redeemscript.to_v0_p2wsh();
1693
1694                         let local_payment_p2wpkh = if let Some(payment_key) = local_payment_key {
1695                                 // Note that the Network here is ignored as we immediately drop the address for the
1696                                 // script_pubkey version.
1697                                 let payment_hash160 = Hash160::hash(&PublicKey::from_secret_key(&self.secp_ctx, &payment_key).serialize());
1698                                 Some(Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&payment_hash160[..]).into_script())
1699                         } else { None };
1700
1701                         let mut total_value = 0;
1702                         let mut inputs = Vec::new();
1703                         let mut inputs_info = Vec::new();
1704                         let mut inputs_desc = Vec::new();
1705
1706                         for (idx, outp) in tx.output.iter().enumerate() {
1707                                 if outp.script_pubkey == revokeable_p2wsh {
1708                                         inputs.push(TxIn {
1709                                                 previous_output: BitcoinOutPoint {
1710                                                         txid: commitment_txid,
1711                                                         vout: idx as u32,
1712                                                 },
1713                                                 script_sig: Script::new(),
1714                                                 sequence: 0xfffffffd,
1715                                                 witness: Vec::new(),
1716                                         });
1717                                         inputs_desc.push(InputDescriptors::RevokedOutput);
1718                                         inputs_info.push((None, outp.value, self.our_to_self_delay as u32));
1719                                         total_value += outp.value;
1720                                 } else if Some(&outp.script_pubkey) == local_payment_p2wpkh.as_ref() {
1721                                         spendable_outputs.push(SpendableOutputDescriptor::DynamicOutputP2WPKH {
1722                                                 outpoint: BitcoinOutPoint { txid: commitment_txid, vout: idx as u32 },
1723                                                 key: local_payment_key.unwrap(),
1724                                                 output: outp.clone(),
1725                                         });
1726                                 }
1727                         }
1728
1729                         macro_rules! sign_input {
1730                                 ($sighash_parts: expr, $input: expr, $htlc_idx: expr, $amount: expr) => {
1731                                         {
1732                                                 let (sig, redeemscript, revocation_key) = match self.key_storage {
1733                                                         Storage::Local { ref revocation_base_key, .. } => {
1734                                                                 let redeemscript = if $htlc_idx.is_none() { revokeable_redeemscript.clone() } else {
1735                                                                         let htlc = &per_commitment_option.unwrap()[$htlc_idx.unwrap()].0;
1736                                                                         chan_utils::get_htlc_redeemscript_with_explicit_keys(htlc, &a_htlc_key, &b_htlc_key, &revocation_pubkey)
1737                                                                 };
1738                                                                 let sighash = hash_to_message!(&$sighash_parts.sighash_all(&$input, &redeemscript, $amount)[..]);
1739                                                                 let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &revocation_base_key));
1740                                                                 (self.secp_ctx.sign(&sighash, &revocation_key), redeemscript, revocation_key)
1741                                                         },
1742                                                         Storage::Watchtower { .. } => {
1743                                                                 unimplemented!();
1744                                                         }
1745                                                 };
1746                                                 $input.witness.push(sig.serialize_der().to_vec());
1747                                                 $input.witness[0].push(SigHashType::All as u8);
1748                                                 if $htlc_idx.is_none() {
1749                                                         $input.witness.push(vec!(1));
1750                                                 } else {
1751                                                         $input.witness.push(revocation_pubkey.serialize().to_vec());
1752                                                 }
1753                                                 $input.witness.push(redeemscript.clone().into_bytes());
1754                                                 (redeemscript, revocation_key)
1755                                         }
1756                                 }
1757                         }
1758
1759                         if let Some(ref per_commitment_data) = per_commitment_option {
1760                                 inputs.reserve_exact(per_commitment_data.len());
1761
1762                                 for (idx, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
1763                                         if let Some(transaction_output_index) = htlc.transaction_output_index {
1764                                                 let expected_script = chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, &a_htlc_key, &b_htlc_key, &revocation_pubkey);
1765                                                 if transaction_output_index as usize >= tx.output.len() ||
1766                                                                 tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 ||
1767                                                                 tx.output[transaction_output_index as usize].script_pubkey != expected_script.to_v0_p2wsh() {
1768                                                         return (txn_to_broadcast, (commitment_txid, watch_outputs), spendable_outputs); // Corrupted per_commitment_data, fuck this user
1769                                                 }
1770                                                 let input = TxIn {
1771                                                         previous_output: BitcoinOutPoint {
1772                                                                 txid: commitment_txid,
1773                                                                 vout: transaction_output_index,
1774                                                         },
1775                                                         script_sig: Script::new(),
1776                                                         sequence: 0xfffffffd,
1777                                                         witness: Vec::new(),
1778                                                 };
1779                                                 if htlc.cltv_expiry > height + CLTV_SHARED_CLAIM_BUFFER {
1780                                                         inputs.push(input);
1781                                                         inputs_desc.push(if htlc.offered { InputDescriptors::RevokedOfferedHTLC } else { InputDescriptors::RevokedReceivedHTLC });
1782                                                         inputs_info.push((Some(idx), tx.output[transaction_output_index as usize].value, htlc.cltv_expiry));
1783                                                         total_value += tx.output[transaction_output_index as usize].value;
1784                                                 } else {
1785                                                         let mut single_htlc_tx = Transaction {
1786                                                                 version: 2,
1787                                                                 lock_time: 0,
1788                                                                 input: vec![input],
1789                                                                 output: vec!(TxOut {
1790                                                                         script_pubkey: self.destination_script.clone(),
1791                                                                         value: htlc.amount_msat / 1000,
1792                                                                 }),
1793                                                         };
1794                                                         let predicted_weight = single_htlc_tx.get_weight() + Self::get_witnesses_weight(&[if htlc.offered { InputDescriptors::RevokedOfferedHTLC } else { InputDescriptors::RevokedReceivedHTLC }]);
1795                                                         let height_timer = Self::get_height_timer(height, htlc.cltv_expiry);
1796                                                         let mut used_feerate;
1797                                                         if subtract_high_prio_fee!(self, fee_estimator, single_htlc_tx.output[0].value, predicted_weight, used_feerate) {
1798                                                                 let sighash_parts = bip143::SighashComponents::new(&single_htlc_tx);
1799                                                                 let (redeemscript, revocation_key) = sign_input!(sighash_parts, single_htlc_tx.input[0], Some(idx), htlc.amount_msat / 1000);
1800                                                                 assert!(predicted_weight >= single_htlc_tx.get_weight());
1801                                                                 log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", single_htlc_tx.input[0].previous_output.txid, single_htlc_tx.input[0].previous_output.vout, height_timer);
1802                                                                 let mut per_input_material = HashMap::with_capacity(1);
1803                                                                 per_input_material.insert(single_htlc_tx.input[0].previous_output, InputMaterial::Revoked { script: redeemscript, pubkey: Some(revocation_pubkey), key: revocation_key, is_htlc: true, amount: htlc.amount_msat / 1000 });
1804                                                                 match self.claimable_outpoints.entry(single_htlc_tx.input[0].previous_output) {
1805                                                                         hash_map::Entry::Occupied(_) => {},
1806                                                                         hash_map::Entry::Vacant(entry) => { entry.insert((single_htlc_tx.txid(), height)); }
1807                                                                 }
1808                                                                 match self.pending_claim_requests.entry(single_htlc_tx.txid()) {
1809                                                                         hash_map::Entry::Occupied(_) => {},
1810                                                                         hash_map::Entry::Vacant(entry) => { entry.insert(ClaimTxBumpMaterial { height_timer, feerate_previous: used_feerate, soonest_timelock: htlc.cltv_expiry, per_input_material }); }
1811                                                                 }
1812                                                                 txn_to_broadcast.push(single_htlc_tx);
1813                                                         }
1814                                                 }
1815                                         }
1816                                 }
1817                         }
1818
1819                         if !inputs.is_empty() || !txn_to_broadcast.is_empty() || per_commitment_option.is_some() { // ie we're confident this is actually ours
1820                                 // We're definitely a remote commitment transaction!
1821                                 log_trace!(self, "Got broadcast of revoked remote commitment transaction, generating general spend tx with {} inputs and {} other txn to broadcast", inputs.len(), txn_to_broadcast.len());
1822                                 watch_outputs.append(&mut tx.output.clone());
1823                                 self.remote_commitment_txn_on_chain.insert(commitment_txid, (commitment_number, tx.output.iter().map(|output| { output.script_pubkey.clone() }).collect()));
1824
1825                                 macro_rules! check_htlc_fails {
1826                                         ($txid: expr, $commitment_tx: expr) => {
1827                                                 if let Some(ref outpoints) = self.remote_claimable_outpoints.get($txid) {
1828                                                         for &(ref htlc, ref source_option) in outpoints.iter() {
1829                                                                 if let &Some(ref source) = source_option {
1830                                                                         log_info!(self, "Failing HTLC with payment_hash {} from {} remote commitment tx due to broadcast of revoked remote commitment transaction, waiting for confirmation (at height {})", log_bytes!(htlc.payment_hash.0), $commitment_tx, height + ANTI_REORG_DELAY - 1);
1831                                                                         match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
1832                                                                                 hash_map::Entry::Occupied(mut entry) => {
1833                                                                                         let e = entry.get_mut();
1834                                                                                         e.retain(|ref event| {
1835                                                                                                 match **event {
1836                                                                                                         OnchainEvent::HTLCUpdate { ref htlc_update } => {
1837                                                                                                                 return htlc_update.0 != **source
1838                                                                                                         },
1839                                                                                                         _ => return true
1840                                                                                                 }
1841                                                                                         });
1842                                                                                         e.push(OnchainEvent::HTLCUpdate { htlc_update: ((**source).clone(), htlc.payment_hash.clone())});
1843                                                                                 }
1844                                                                                 hash_map::Entry::Vacant(entry) => {
1845                                                                                         entry.insert(vec![OnchainEvent::HTLCUpdate { htlc_update: ((**source).clone(), htlc.payment_hash.clone())}]);
1846                                                                                 }
1847                                                                         }
1848                                                                 }
1849                                                         }
1850                                                 }
1851                                         }
1852                                 }
1853                                 if let Storage::Local { ref current_remote_commitment_txid, ref prev_remote_commitment_txid, .. } = self.key_storage {
1854                                         if let &Some(ref txid) = current_remote_commitment_txid {
1855                                                 check_htlc_fails!(txid, "current");
1856                                         }
1857                                         if let &Some(ref txid) = prev_remote_commitment_txid {
1858                                                 check_htlc_fails!(txid, "remote");
1859                                         }
1860                                 }
1861                                 // No need to check local commitment txn, symmetric HTLCSource must be present as per-htlc data on remote commitment tx
1862                         }
1863                         if inputs.is_empty() { return (txn_to_broadcast, (commitment_txid, watch_outputs), spendable_outputs); } // Nothing to be done...probably a false positive/local tx
1864
1865                         let outputs = vec!(TxOut {
1866                                 script_pubkey: self.destination_script.clone(),
1867                                 value: total_value,
1868                         });
1869                         let mut spend_tx = Transaction {
1870                                 version: 2,
1871                                 lock_time: 0,
1872                                 input: inputs,
1873                                 output: outputs,
1874                         };
1875
1876                         let predicted_weight = spend_tx.get_weight() + Self::get_witnesses_weight(&inputs_desc[..]);
1877
1878                         let mut used_feerate;
1879                         if !subtract_high_prio_fee!(self, fee_estimator, spend_tx.output[0].value, predicted_weight, used_feerate) {
1880                                 return (txn_to_broadcast, (commitment_txid, watch_outputs), spendable_outputs);
1881                         }
1882
1883                         let sighash_parts = bip143::SighashComponents::new(&spend_tx);
1884
1885                         let mut per_input_material = HashMap::with_capacity(spend_tx.input.len());
1886                         let mut soonest_timelock = ::std::u32::MAX;
1887                         for info in inputs_info.iter() {
1888                                 if info.2 <= soonest_timelock {
1889                                         soonest_timelock = info.2;
1890                                 }
1891                         }
1892                         let height_timer = Self::get_height_timer(height, soonest_timelock);
1893                         let spend_txid = spend_tx.txid();
1894                         for (input, info) in spend_tx.input.iter_mut().zip(inputs_info.iter()) {
1895                                 let (redeemscript, revocation_key) = sign_input!(sighash_parts, input, info.0, info.1);
1896                                 log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", input.previous_output.txid, input.previous_output.vout, height_timer);
1897                                 per_input_material.insert(input.previous_output, InputMaterial::Revoked { script: redeemscript, pubkey: if info.0.is_some() { Some(revocation_pubkey) } else { None }, key: revocation_key, is_htlc: if info.0.is_some() { true } else { false }, amount: info.1 });
1898                                 match self.claimable_outpoints.entry(input.previous_output) {
1899                                         hash_map::Entry::Occupied(_) => {},
1900                                         hash_map::Entry::Vacant(entry) => { entry.insert((spend_txid, height)); }
1901                                 }
1902                         }
1903                         match self.pending_claim_requests.entry(spend_txid) {
1904                                 hash_map::Entry::Occupied(_) => {},
1905                                 hash_map::Entry::Vacant(entry) => { entry.insert(ClaimTxBumpMaterial { height_timer, feerate_previous: used_feerate, soonest_timelock, per_input_material }); }
1906                         }
1907
1908                         assert!(predicted_weight >= spend_tx.get_weight());
1909
1910                         spendable_outputs.push(SpendableOutputDescriptor::StaticOutput {
1911                                 outpoint: BitcoinOutPoint { txid: spend_tx.txid(), vout: 0 },
1912                                 output: spend_tx.output[0].clone(),
1913                         });
1914                         txn_to_broadcast.push(spend_tx);
1915                 } else if let Some(per_commitment_data) = per_commitment_option {
1916                         // While this isn't useful yet, there is a potential race where if a counterparty
1917                         // revokes a state at the same time as the commitment transaction for that state is
1918                         // confirmed, and the watchtower receives the block before the user, the user could
1919                         // upload a new ChannelMonitor with the revocation secret but the watchtower has
1920                         // already processed the block, resulting in the remote_commitment_txn_on_chain entry
1921                         // not being generated by the above conditional. Thus, to be safe, we go ahead and
1922                         // insert it here.
1923                         watch_outputs.append(&mut tx.output.clone());
1924                         self.remote_commitment_txn_on_chain.insert(commitment_txid, (commitment_number, tx.output.iter().map(|output| { output.script_pubkey.clone() }).collect()));
1925
1926                         log_trace!(self, "Got broadcast of non-revoked remote commitment transaction {}", commitment_txid);
1927
1928                         macro_rules! check_htlc_fails {
1929                                 ($txid: expr, $commitment_tx: expr, $id: tt) => {
1930                                         if let Some(ref latest_outpoints) = self.remote_claimable_outpoints.get($txid) {
1931                                                 $id: for &(ref htlc, ref source_option) in latest_outpoints.iter() {
1932                                                         if let &Some(ref source) = source_option {
1933                                                                 // Check if the HTLC is present in the commitment transaction that was
1934                                                                 // broadcast, but not if it was below the dust limit, which we should
1935                                                                 // fail backwards immediately as there is no way for us to learn the
1936                                                                 // payment_preimage.
1937                                                                 // Note that if the dust limit were allowed to change between
1938                                                                 // commitment transactions we'd want to be check whether *any*
1939                                                                 // broadcastable commitment transaction has the HTLC in it, but it
1940                                                                 // cannot currently change after channel initialization, so we don't
1941                                                                 // need to here.
1942                                                                 for &(ref broadcast_htlc, ref broadcast_source) in per_commitment_data.iter() {
1943                                                                         if broadcast_htlc.transaction_output_index.is_some() && Some(source) == broadcast_source.as_ref() {
1944                                                                                 continue $id;
1945                                                                         }
1946                                                                 }
1947                                                                 log_trace!(self, "Failing HTLC with payment_hash {} from {} remote commitment tx due to broadcast of remote commitment transaction", log_bytes!(htlc.payment_hash.0), $commitment_tx);
1948                                                                 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
1949                                                                         hash_map::Entry::Occupied(mut entry) => {
1950                                                                                 let e = entry.get_mut();
1951                                                                                 e.retain(|ref event| {
1952                                                                                         match **event {
1953                                                                                                 OnchainEvent::HTLCUpdate { ref htlc_update } => {
1954                                                                                                         return htlc_update.0 != **source
1955                                                                                                 },
1956                                                                                                 _ => return true
1957                                                                                         }
1958                                                                                 });
1959                                                                                 e.push(OnchainEvent::HTLCUpdate { htlc_update: ((**source).clone(), htlc.payment_hash.clone())});
1960                                                                         }
1961                                                                         hash_map::Entry::Vacant(entry) => {
1962                                                                                 entry.insert(vec![OnchainEvent::HTLCUpdate { htlc_update: ((**source).clone(), htlc.payment_hash.clone())}]);
1963                                                                         }
1964                                                                 }
1965                                                         }
1966                                                 }
1967                                         }
1968                                 }
1969                         }
1970                         if let Storage::Local { ref current_remote_commitment_txid, ref prev_remote_commitment_txid, .. } = self.key_storage {
1971                                 if let &Some(ref txid) = current_remote_commitment_txid {
1972                                         check_htlc_fails!(txid, "current", 'current_loop);
1973                                 }
1974                                 if let &Some(ref txid) = prev_remote_commitment_txid {
1975                                         check_htlc_fails!(txid, "previous", 'prev_loop);
1976                                 }
1977                         }
1978
1979                         if let Some(revocation_points) = self.their_cur_revocation_points {
1980                                 let revocation_point_option =
1981                                         if revocation_points.0 == commitment_number { Some(&revocation_points.1) }
1982                                         else if let Some(point) = revocation_points.2.as_ref() {
1983                                                 if revocation_points.0 == commitment_number + 1 { Some(point) } else { None }
1984                                         } else { None };
1985                                 if let Some(revocation_point) = revocation_point_option {
1986                                         let (revocation_pubkey, b_htlc_key) = match self.key_storage {
1987                                                 Storage::Local { ref keys, .. } => {
1988                                                         (ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &keys.pubkeys().revocation_basepoint)),
1989                                                         ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &keys.pubkeys().htlc_basepoint)))
1990                                                 },
1991                                                 Storage::Watchtower { ref revocation_base_key, ref htlc_base_key, .. } => {
1992                                                         (ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, revocation_point, &revocation_base_key)),
1993                                                         ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &htlc_base_key)))
1994                                                 },
1995                                         };
1996                                         let a_htlc_key = match self.their_htlc_base_key {
1997                                                 None => return (txn_to_broadcast, (commitment_txid, watch_outputs), spendable_outputs),
1998                                                 Some(their_htlc_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, revocation_point, &their_htlc_base_key)),
1999                                         };
2000
2001                                         for (idx, outp) in tx.output.iter().enumerate() {
2002                                                 if outp.script_pubkey.is_v0_p2wpkh() {
2003                                                         match self.key_storage {
2004                                                                 Storage::Local { ref payment_base_key, .. } => {
2005                                                                         if let Ok(local_key) = chan_utils::derive_private_key(&self.secp_ctx, &revocation_point, &payment_base_key) {
2006                                                                                 spendable_outputs.push(SpendableOutputDescriptor::DynamicOutputP2WPKH {
2007                                                                                         outpoint: BitcoinOutPoint { txid: commitment_txid, vout: idx as u32 },
2008                                                                                         key: local_key,
2009                                                                                         output: outp.clone(),
2010                                                                                 });
2011                                                                         }
2012                                                                 },
2013                                                                 Storage::Watchtower { .. } => {}
2014                                                         }
2015                                                         break; // Only to_remote ouput is claimable
2016                                                 }
2017                                         }
2018
2019                                         let mut total_value = 0;
2020                                         let mut inputs = Vec::new();
2021                                         let mut inputs_desc = Vec::new();
2022                                         let mut inputs_info = Vec::new();
2023
2024                                         macro_rules! sign_input {
2025                                                 ($sighash_parts: expr, $input: expr, $amount: expr, $preimage: expr, $idx: expr) => {
2026                                                         {
2027                                                                 let (sig, redeemscript, htlc_key) = match self.key_storage {
2028                                                                         Storage::Local { ref htlc_base_key, .. } => {
2029                                                                                 let htlc = &per_commitment_option.unwrap()[$idx as usize].0;
2030                                                                                 let redeemscript = chan_utils::get_htlc_redeemscript_with_explicit_keys(htlc, &a_htlc_key, &b_htlc_key, &revocation_pubkey);
2031                                                                                 let sighash = hash_to_message!(&$sighash_parts.sighash_all(&$input, &redeemscript, $amount)[..]);
2032                                                                                 let htlc_key = ignore_error!(chan_utils::derive_private_key(&self.secp_ctx, revocation_point, &htlc_base_key));
2033                                                                                 (self.secp_ctx.sign(&sighash, &htlc_key), redeemscript, htlc_key)
2034                                                                         },
2035                                                                         Storage::Watchtower { .. } => {
2036                                                                                 unimplemented!();
2037                                                                         }
2038                                                                 };
2039                                                                 $input.witness.push(sig.serialize_der().to_vec());
2040                                                                 $input.witness[0].push(SigHashType::All as u8);
2041                                                                 $input.witness.push($preimage);
2042                                                                 $input.witness.push(redeemscript.clone().into_bytes());
2043                                                                 (redeemscript, htlc_key)
2044                                                         }
2045                                                 }
2046                                         }
2047
2048                                         for (idx, &(ref htlc, _)) in per_commitment_data.iter().enumerate() {
2049                                                 if let Some(transaction_output_index) = htlc.transaction_output_index {
2050                                                         let expected_script = chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, &a_htlc_key, &b_htlc_key, &revocation_pubkey);
2051                                                         if transaction_output_index as usize >= tx.output.len() ||
2052                                                                         tx.output[transaction_output_index as usize].value != htlc.amount_msat / 1000 ||
2053                                                                         tx.output[transaction_output_index as usize].script_pubkey != expected_script.to_v0_p2wsh() {
2054                                                                 return (txn_to_broadcast, (commitment_txid, watch_outputs), spendable_outputs); // Corrupted per_commitment_data, fuck this user
2055                                                         }
2056                                                         if let Some(payment_preimage) = self.payment_preimages.get(&htlc.payment_hash) {
2057                                                                 if htlc.offered {
2058                                                                         let input = TxIn {
2059                                                                                 previous_output: BitcoinOutPoint {
2060                                                                                         txid: commitment_txid,
2061                                                                                         vout: transaction_output_index,
2062                                                                                 },
2063                                                                                 script_sig: Script::new(),
2064                                                                                 sequence: 0xff_ff_ff_fd,
2065                                                                                 witness: Vec::new(),
2066                                                                         };
2067                                                                         if htlc.cltv_expiry > height + CLTV_SHARED_CLAIM_BUFFER {
2068                                                                                 inputs.push(input);
2069                                                                                 inputs_desc.push(if htlc.offered { InputDescriptors::OfferedHTLC } else { InputDescriptors::ReceivedHTLC });
2070                                                                                 inputs_info.push((payment_preimage, tx.output[transaction_output_index as usize].value, htlc.cltv_expiry, idx));
2071                                                                                 total_value += tx.output[transaction_output_index as usize].value;
2072                                                                         } else {
2073                                                                                 let mut single_htlc_tx = Transaction {
2074                                                                                         version: 2,
2075                                                                                         lock_time: 0,
2076                                                                                         input: vec![input],
2077                                                                                         output: vec!(TxOut {
2078                                                                                                 script_pubkey: self.destination_script.clone(),
2079                                                                                                 value: htlc.amount_msat / 1000,
2080                                                                                         }),
2081                                                                                 };
2082                                                                                 let predicted_weight = single_htlc_tx.get_weight() + Self::get_witnesses_weight(&[if htlc.offered { InputDescriptors::OfferedHTLC } else { InputDescriptors::ReceivedHTLC }]);
2083                                                                                 let height_timer = Self::get_height_timer(height, htlc.cltv_expiry);
2084                                                                                 let mut used_feerate;
2085                                                                                 if subtract_high_prio_fee!(self, fee_estimator, single_htlc_tx.output[0].value, predicted_weight, used_feerate) {
2086                                                                                         let sighash_parts = bip143::SighashComponents::new(&single_htlc_tx);
2087                                                                                         let (redeemscript, htlc_key) = sign_input!(sighash_parts, single_htlc_tx.input[0], htlc.amount_msat / 1000, payment_preimage.0.to_vec(), idx);
2088                                                                                         assert!(predicted_weight >= single_htlc_tx.get_weight());
2089                                                                                         spendable_outputs.push(SpendableOutputDescriptor::StaticOutput {
2090                                                                                                 outpoint: BitcoinOutPoint { txid: single_htlc_tx.txid(), vout: 0 },
2091                                                                                                 output: single_htlc_tx.output[0].clone(),
2092                                                                                         });
2093                                                                                         log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", single_htlc_tx.input[0].previous_output.txid, single_htlc_tx.input[0].previous_output.vout, height_timer);
2094                                                                                         let mut per_input_material = HashMap::with_capacity(1);
2095                                                                                         per_input_material.insert(single_htlc_tx.input[0].previous_output, InputMaterial::RemoteHTLC { script: redeemscript, key: htlc_key, preimage: Some(*payment_preimage), amount: htlc.amount_msat / 1000, locktime: 0 });
2096                                                                                         match self.claimable_outpoints.entry(single_htlc_tx.input[0].previous_output) {
2097                                                                                                 hash_map::Entry::Occupied(_) => {},
2098                                                                                                 hash_map::Entry::Vacant(entry) => { entry.insert((single_htlc_tx.txid(), height)); }
2099                                                                                         }
2100                                                                                         match self.pending_claim_requests.entry(single_htlc_tx.txid()) {
2101                                                                                                 hash_map::Entry::Occupied(_) => {},
2102                                                                                                 hash_map::Entry::Vacant(entry) => { entry.insert(ClaimTxBumpMaterial { height_timer, feerate_previous: used_feerate, soonest_timelock: htlc.cltv_expiry, per_input_material}); }
2103                                                                                         }
2104                                                                                         txn_to_broadcast.push(single_htlc_tx);
2105                                                                                 }
2106                                                                         }
2107                                                                 }
2108                                                         }
2109                                                         if !htlc.offered {
2110                                                                 // TODO: If the HTLC has already expired, potentially merge it with the
2111                                                                 // rest of the claim transaction, as above.
2112                                                                 let input = TxIn {
2113                                                                         previous_output: BitcoinOutPoint {
2114                                                                                 txid: commitment_txid,
2115                                                                                 vout: transaction_output_index,
2116                                                                         },
2117                                                                         script_sig: Script::new(),
2118                                                                         sequence: 0xff_ff_ff_fd,
2119                                                                         witness: Vec::new(),
2120                                                                 };
2121                                                                 let mut timeout_tx = Transaction {
2122                                                                         version: 2,
2123                                                                         lock_time: htlc.cltv_expiry,
2124                                                                         input: vec![input],
2125                                                                         output: vec!(TxOut {
2126                                                                                 script_pubkey: self.destination_script.clone(),
2127                                                                                 value: htlc.amount_msat / 1000,
2128                                                                         }),
2129                                                                 };
2130                                                                 let predicted_weight = timeout_tx.get_weight() + Self::get_witnesses_weight(&[InputDescriptors::ReceivedHTLC]);
2131                                                                 let height_timer = Self::get_height_timer(height, htlc.cltv_expiry);
2132                                                                 let mut used_feerate;
2133                                                                 if subtract_high_prio_fee!(self, fee_estimator, timeout_tx.output[0].value, predicted_weight, used_feerate) {
2134                                                                         let sighash_parts = bip143::SighashComponents::new(&timeout_tx);
2135                                                                         let (redeemscript, htlc_key) = sign_input!(sighash_parts, timeout_tx.input[0], htlc.amount_msat / 1000, vec![0], idx);
2136                                                                         assert!(predicted_weight >= timeout_tx.get_weight());
2137                                                                         //TODO: track SpendableOutputDescriptor
2138                                                                         log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", timeout_tx.input[0].previous_output.txid, timeout_tx.input[0].previous_output.vout, height_timer);
2139                                                                         let mut per_input_material = HashMap::with_capacity(1);
2140                                                                         per_input_material.insert(timeout_tx.input[0].previous_output, InputMaterial::RemoteHTLC { script : redeemscript, key: htlc_key, preimage: None, amount: htlc.amount_msat / 1000, locktime: htlc.cltv_expiry });
2141                                                                         match self.claimable_outpoints.entry(timeout_tx.input[0].previous_output) {
2142                                                                                 hash_map::Entry::Occupied(_) => {},
2143                                                                                 hash_map::Entry::Vacant(entry) => { entry.insert((timeout_tx.txid(), height)); }
2144                                                                         }
2145                                                                         match self.pending_claim_requests.entry(timeout_tx.txid()) {
2146                                                                                 hash_map::Entry::Occupied(_) => {},
2147                                                                                 hash_map::Entry::Vacant(entry) => { entry.insert(ClaimTxBumpMaterial { height_timer, feerate_previous: used_feerate, soonest_timelock: htlc.cltv_expiry, per_input_material }); }
2148                                                                         }
2149                                                                 }
2150                                                                 txn_to_broadcast.push(timeout_tx);
2151                                                         }
2152                                                 }
2153                                         }
2154
2155                                         if inputs.is_empty() { return (txn_to_broadcast, (commitment_txid, watch_outputs), spendable_outputs); } // Nothing to be done...probably a false positive/local tx
2156
2157                                         let outputs = vec!(TxOut {
2158                                                 script_pubkey: self.destination_script.clone(),
2159                                                 value: total_value
2160                                         });
2161                                         let mut spend_tx = Transaction {
2162                                                 version: 2,
2163                                                 lock_time: 0,
2164                                                 input: inputs,
2165                                                 output: outputs,
2166                                         };
2167
2168                                         let predicted_weight = spend_tx.get_weight() + Self::get_witnesses_weight(&inputs_desc[..]);
2169
2170                                         let mut used_feerate;
2171                                         if !subtract_high_prio_fee!(self, fee_estimator, spend_tx.output[0].value, predicted_weight, used_feerate) {
2172                                                 return (txn_to_broadcast, (commitment_txid, watch_outputs), spendable_outputs);
2173                                         }
2174
2175                                         let sighash_parts = bip143::SighashComponents::new(&spend_tx);
2176
2177                                         let mut per_input_material = HashMap::with_capacity(spend_tx.input.len());
2178                                         let mut soonest_timelock = ::std::u32::MAX;
2179                                         for info in inputs_info.iter() {
2180                                                 if info.2 <= soonest_timelock {
2181                                                         soonest_timelock = info.2;
2182                                                 }
2183                                         }
2184                                         let height_timer = Self::get_height_timer(height, soonest_timelock);
2185                                         let spend_txid = spend_tx.txid();
2186                                         for (input, info) in spend_tx.input.iter_mut().zip(inputs_info.iter()) {
2187                                                 let (redeemscript, htlc_key) = sign_input!(sighash_parts, input, info.1, (info.0).0.to_vec(), info.3);
2188                                                 log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", input.previous_output.txid, input.previous_output.vout, height_timer);
2189                                                 per_input_material.insert(input.previous_output, InputMaterial::RemoteHTLC { script: redeemscript, key: htlc_key, preimage: Some(*(info.0)), amount: info.1, locktime: 0});
2190                                                 match self.claimable_outpoints.entry(input.previous_output) {
2191                                                         hash_map::Entry::Occupied(_) => {},
2192                                                         hash_map::Entry::Vacant(entry) => { entry.insert((spend_txid, height)); }
2193                                                 }
2194                                         }
2195                                         match self.pending_claim_requests.entry(spend_txid) {
2196                                                 hash_map::Entry::Occupied(_) => {},
2197                                                 hash_map::Entry::Vacant(entry) => { entry.insert(ClaimTxBumpMaterial { height_timer, feerate_previous: used_feerate, soonest_timelock, per_input_material }); }
2198                                         }
2199                                         assert!(predicted_weight >= spend_tx.get_weight());
2200                                         spendable_outputs.push(SpendableOutputDescriptor::StaticOutput {
2201                                                 outpoint: BitcoinOutPoint { txid: spend_tx.txid(), vout: 0 },
2202                                                 output: spend_tx.output[0].clone(),
2203                                         });
2204                                         txn_to_broadcast.push(spend_tx);
2205                                 }
2206                         }
2207                 } else if let Some((ref to_remote_rescue, ref local_key)) = self.to_remote_rescue {
2208                         for (idx, outp) in tx.output.iter().enumerate() {
2209                                 if to_remote_rescue == &outp.script_pubkey {
2210                                         spendable_outputs.push(SpendableOutputDescriptor::DynamicOutputP2WPKH {
2211                                                 outpoint: BitcoinOutPoint { txid: commitment_txid, vout: idx as u32 },
2212                                                 key: local_key.clone(),
2213                                                 output: outp.clone(),
2214                                         });
2215                                 }
2216                         }
2217                 }
2218
2219                 (txn_to_broadcast, (commitment_txid, watch_outputs), spendable_outputs)
2220         }
2221
2222         /// Attempts to claim a remote HTLC-Success/HTLC-Timeout's outputs using the revocation key
2223         fn check_spend_remote_htlc(&mut self, tx: &Transaction, commitment_number: u64, height: u32, fee_estimator: &FeeEstimator) -> (Option<Transaction>, Option<SpendableOutputDescriptor>) {
2224                 //TODO: send back new outputs to guarantee pending_claim_request consistency
2225                 if tx.input.len() != 1 || tx.output.len() != 1 {
2226                         return (None, None)
2227                 }
2228
2229                 macro_rules! ignore_error {
2230                         ( $thing : expr ) => {
2231                                 match $thing {
2232                                         Ok(a) => a,
2233                                         Err(_) => return (None, None)
2234                                 }
2235                         };
2236                 }
2237
2238                 let secret = if let Some(secret) = self.get_secret(commitment_number) { secret } else { return (None, None); };
2239                 let per_commitment_key = ignore_error!(SecretKey::from_slice(&secret));
2240                 let per_commitment_point = PublicKey::from_secret_key(&self.secp_ctx, &per_commitment_key);
2241                 let revocation_pubkey = match self.key_storage {
2242                         Storage::Local { ref keys, .. } => {
2243                                 ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &keys.pubkeys().revocation_basepoint))
2244                         },
2245                         Storage::Watchtower { ref revocation_base_key, .. } => {
2246                                 ignore_error!(chan_utils::derive_public_revocation_key(&self.secp_ctx, &per_commitment_point, &revocation_base_key))
2247                         },
2248                 };
2249                 let delayed_key = match self.their_delayed_payment_base_key {
2250                         None => return (None, None),
2251                         Some(their_delayed_payment_base_key) => ignore_error!(chan_utils::derive_public_key(&self.secp_ctx, &per_commitment_point, &their_delayed_payment_base_key)),
2252                 };
2253                 let redeemscript = chan_utils::get_revokeable_redeemscript(&revocation_pubkey, self.our_to_self_delay, &delayed_key);
2254                 let revokeable_p2wsh = redeemscript.to_v0_p2wsh();
2255                 let htlc_txid = tx.txid(); //TODO: This is gonna be a performance bottleneck for watchtowers!
2256
2257                 let mut inputs = Vec::new();
2258                 let mut amount = 0;
2259
2260                 if tx.output[0].script_pubkey == revokeable_p2wsh { //HTLC transactions have one txin, one txout
2261                         inputs.push(TxIn {
2262                                 previous_output: BitcoinOutPoint {
2263                                         txid: htlc_txid,
2264                                         vout: 0,
2265                                 },
2266                                 script_sig: Script::new(),
2267                                 sequence: 0xfffffffd,
2268                                 witness: Vec::new(),
2269                         });
2270                         amount = tx.output[0].value;
2271                 }
2272
2273                 if !inputs.is_empty() {
2274                         let outputs = vec!(TxOut {
2275                                 script_pubkey: self.destination_script.clone(),
2276                                 value: amount
2277                         });
2278
2279                         let mut spend_tx = Transaction {
2280                                 version: 2,
2281                                 lock_time: 0,
2282                                 input: inputs,
2283                                 output: outputs,
2284                         };
2285                         let predicted_weight = spend_tx.get_weight() + Self::get_witnesses_weight(&[InputDescriptors::RevokedOutput]);
2286                         let mut used_feerate;
2287                         if !subtract_high_prio_fee!(self, fee_estimator, spend_tx.output[0].value, predicted_weight, used_feerate) {
2288                                 return (None, None);
2289                         }
2290
2291                         let sighash_parts = bip143::SighashComponents::new(&spend_tx);
2292
2293                         let (sig, revocation_key) = match self.key_storage {
2294                                 Storage::Local { ref revocation_base_key, .. } => {
2295                                         let sighash = hash_to_message!(&sighash_parts.sighash_all(&spend_tx.input[0], &redeemscript, amount)[..]);
2296                                         let revocation_key = ignore_error!(chan_utils::derive_private_revocation_key(&self.secp_ctx, &per_commitment_key, &revocation_base_key));
2297                                         (self.secp_ctx.sign(&sighash, &revocation_key), revocation_key)
2298                                 }
2299                                 Storage::Watchtower { .. } => {
2300                                         unimplemented!();
2301                                 }
2302                         };
2303                         spend_tx.input[0].witness.push(sig.serialize_der().to_vec());
2304                         spend_tx.input[0].witness[0].push(SigHashType::All as u8);
2305                         spend_tx.input[0].witness.push(vec!(1));
2306                         spend_tx.input[0].witness.push(redeemscript.clone().into_bytes());
2307
2308                         assert!(predicted_weight >= spend_tx.get_weight());
2309                         let outpoint = BitcoinOutPoint { txid: spend_tx.txid(), vout: 0 };
2310                         let output = spend_tx.output[0].clone();
2311                         let height_timer = Self::get_height_timer(height, height + self.our_to_self_delay as u32);
2312                         log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", spend_tx.input[0].previous_output.txid, spend_tx.input[0].previous_output.vout, height_timer);
2313                         let mut per_input_material = HashMap::with_capacity(1);
2314                         per_input_material.insert(spend_tx.input[0].previous_output, InputMaterial::Revoked { script: redeemscript, pubkey: None, key: revocation_key, is_htlc: false, amount: tx.output[0].value });
2315                         match self.claimable_outpoints.entry(spend_tx.input[0].previous_output) {
2316                                 hash_map::Entry::Occupied(_) => {},
2317                                 hash_map::Entry::Vacant(entry) => { entry.insert((spend_tx.txid(), height)); }
2318                         }
2319                         match self.pending_claim_requests.entry(spend_tx.txid()) {
2320                                 hash_map::Entry::Occupied(_) => {},
2321                                 hash_map::Entry::Vacant(entry) => { entry.insert(ClaimTxBumpMaterial { height_timer, feerate_previous: used_feerate, soonest_timelock: height + self.our_to_self_delay as u32, per_input_material }); }
2322                         }
2323                         (Some(spend_tx), Some(SpendableOutputDescriptor::StaticOutput { outpoint, output }))
2324                 } else { (None, None) }
2325         }
2326
2327         fn broadcast_by_local_state(&self, local_tx: &LocalSignedTx, delayed_payment_base_key: &SecretKey, height: u32) -> (Vec<Transaction>, Vec<SpendableOutputDescriptor>, Vec<TxOut>, Vec<(Sha256dHash, ClaimTxBumpMaterial)>) {
2328                 let mut res = Vec::with_capacity(local_tx.htlc_outputs.len());
2329                 let mut spendable_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());
2330                 let mut watch_outputs = Vec::with_capacity(local_tx.htlc_outputs.len());
2331                 let mut pending_claims = Vec::with_capacity(local_tx.htlc_outputs.len());
2332
2333                 macro_rules! add_dynamic_output {
2334                         ($father_tx: expr, $vout: expr) => {
2335                                 if let Ok(local_delayedkey) = chan_utils::derive_private_key(&self.secp_ctx, &local_tx.per_commitment_point, delayed_payment_base_key) {
2336                                         spendable_outputs.push(SpendableOutputDescriptor::DynamicOutputP2WSH {
2337                                                 outpoint: BitcoinOutPoint { txid: $father_tx.txid(), vout: $vout },
2338                                                 key: local_delayedkey,
2339                                                 witness_script: chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.our_to_self_delay, &local_tx.delayed_payment_key),
2340                                                 to_self_delay: self.our_to_self_delay,
2341                                                 output: $father_tx.output[$vout as usize].clone(),
2342                                         });
2343                                 }
2344                         }
2345                 }
2346
2347                 let redeemscript = chan_utils::get_revokeable_redeemscript(&local_tx.revocation_key, self.their_to_self_delay.unwrap(), &local_tx.delayed_payment_key);
2348                 let revokeable_p2wsh = redeemscript.to_v0_p2wsh();
2349                 for (idx, output) in local_tx.tx.without_valid_witness().output.iter().enumerate() {
2350                         if output.script_pubkey == revokeable_p2wsh {
2351                                 add_dynamic_output!(local_tx.tx.without_valid_witness(), idx as u32);
2352                                 break;
2353                         }
2354                 }
2355
2356                 if let &Storage::Local { ref htlc_base_key, .. } = &self.key_storage {
2357                         for &(ref htlc, ref sigs, _) in local_tx.htlc_outputs.iter() {
2358                                 if let Some(transaction_output_index) = htlc.transaction_output_index {
2359                                         if let &Some(ref their_sig) = sigs {
2360                                                 if htlc.offered {
2361                                                         log_trace!(self, "Broadcasting HTLC-Timeout transaction against local commitment transactions");
2362                                                         let mut htlc_timeout_tx = chan_utils::build_htlc_transaction(&local_tx.txid, local_tx.feerate_per_kw, self.their_to_self_delay.unwrap(), htlc, &local_tx.delayed_payment_key, &local_tx.revocation_key);
2363                                                         let (our_sig, htlc_script) = match
2364                                                                         chan_utils::sign_htlc_transaction(&mut htlc_timeout_tx, their_sig, &None, htlc, &local_tx.a_htlc_key, &local_tx.b_htlc_key, &local_tx.revocation_key, &local_tx.per_commitment_point, htlc_base_key, &self.secp_ctx) {
2365                                                                 Ok(res) => res,
2366                                                                 Err(_) => continue,
2367                                                         };
2368
2369                                                         add_dynamic_output!(htlc_timeout_tx, 0);
2370                                                         let height_timer = Self::get_height_timer(height, htlc.cltv_expiry);
2371                                                         let mut per_input_material = HashMap::with_capacity(1);
2372                                                         per_input_material.insert(htlc_timeout_tx.input[0].previous_output, InputMaterial::LocalHTLC { script: htlc_script, sigs: (*their_sig, our_sig), preimage: None, amount: htlc.amount_msat / 1000});
2373                                                         //TODO: with option_simplified_commitment track outpoint too
2374                                                         log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", htlc_timeout_tx.input[0].previous_output.vout, htlc_timeout_tx.input[0].previous_output.txid, height_timer);
2375                                                         pending_claims.push((htlc_timeout_tx.txid(), ClaimTxBumpMaterial { height_timer, feerate_previous: 0, soonest_timelock: htlc.cltv_expiry, per_input_material }));
2376                                                         res.push(htlc_timeout_tx);
2377                                                 } else {
2378                                                         if let Some(payment_preimage) = self.payment_preimages.get(&htlc.payment_hash) {
2379                                                                 log_trace!(self, "Broadcasting HTLC-Success transaction against local commitment transactions");
2380                                                                 let mut htlc_success_tx = chan_utils::build_htlc_transaction(&local_tx.txid, local_tx.feerate_per_kw, self.their_to_self_delay.unwrap(), htlc, &local_tx.delayed_payment_key, &local_tx.revocation_key);
2381                                                                 let (our_sig, htlc_script) = match
2382                                                                                 chan_utils::sign_htlc_transaction(&mut htlc_success_tx, their_sig, &Some(*payment_preimage), htlc, &local_tx.a_htlc_key, &local_tx.b_htlc_key, &local_tx.revocation_key, &local_tx.per_commitment_point, htlc_base_key, &self.secp_ctx) {
2383                                                                         Ok(res) => res,
2384                                                                         Err(_) => continue,
2385                                                                 };
2386
2387                                                                 add_dynamic_output!(htlc_success_tx, 0);
2388                                                                 let height_timer = Self::get_height_timer(height, htlc.cltv_expiry);
2389                                                                 let mut per_input_material = HashMap::with_capacity(1);
2390                                                                 per_input_material.insert(htlc_success_tx.input[0].previous_output, InputMaterial::LocalHTLC { script: htlc_script, sigs: (*their_sig, our_sig), preimage: Some(*payment_preimage), amount: htlc.amount_msat / 1000});
2391                                                                 //TODO: with option_simplified_commitment track outpoint too
2392                                                                 log_trace!(self, "Outpoint {}:{} is being being claimed, if it doesn't succeed, a bumped claiming txn is going to be broadcast at height {}", htlc_success_tx.input[0].previous_output.vout, htlc_success_tx.input[0].previous_output.txid, height_timer);
2393                                                                 pending_claims.push((htlc_success_tx.txid(), ClaimTxBumpMaterial { height_timer, feerate_previous: 0, soonest_timelock: htlc.cltv_expiry, per_input_material }));
2394                                                                 res.push(htlc_success_tx);
2395                                                         }
2396                                                 }
2397                                                 watch_outputs.push(local_tx.tx.without_valid_witness().output[transaction_output_index as usize].clone());
2398                                         } else { panic!("Should have sigs for non-dust local tx outputs!") }
2399                                 }
2400                         }
2401                 }
2402
2403                 (res, spendable_outputs, watch_outputs, pending_claims)
2404         }
2405
2406         /// Attempts to claim any claimable HTLCs in a commitment transaction which was not (yet)
2407         /// revoked using data in local_claimable_outpoints.
2408         /// Should not be used if check_spend_revoked_transaction succeeds.
2409         fn check_spend_local_transaction(&mut self, tx: &Transaction, height: u32) -> (Vec<Transaction>, Vec<SpendableOutputDescriptor>, (Sha256dHash, Vec<TxOut>)) {
2410                 let commitment_txid = tx.txid();
2411                 let mut local_txn = Vec::new();
2412                 let mut spendable_outputs = Vec::new();
2413                 let mut watch_outputs = Vec::new();
2414
2415                 macro_rules! wait_threshold_conf {
2416                         ($height: expr, $source: expr, $commitment_tx: expr, $payment_hash: expr) => {
2417                                 log_trace!(self, "Failing HTLC with payment_hash {} from {} local commitment tx due to broadcast of transaction, waiting confirmation (at height{})", log_bytes!($payment_hash.0), $commitment_tx, height + ANTI_REORG_DELAY - 1);
2418                                 match self.onchain_events_waiting_threshold_conf.entry($height + ANTI_REORG_DELAY - 1) {
2419                                         hash_map::Entry::Occupied(mut entry) => {
2420                                                 let e = entry.get_mut();
2421                                                 e.retain(|ref event| {
2422                                                         match **event {
2423                                                                 OnchainEvent::HTLCUpdate { ref htlc_update } => {
2424                                                                         return htlc_update.0 != $source
2425                                                                 },
2426                                                                 _ => return true
2427                                                         }
2428                                                 });
2429                                                 e.push(OnchainEvent::HTLCUpdate { htlc_update: ($source, $payment_hash)});
2430                                         }
2431                                         hash_map::Entry::Vacant(entry) => {
2432                                                 entry.insert(vec![OnchainEvent::HTLCUpdate { htlc_update: ($source, $payment_hash)}]);
2433                                         }
2434                                 }
2435                         }
2436                 }
2437
2438                 macro_rules! append_onchain_update {
2439                         ($updates: expr) => {
2440                                 local_txn.append(&mut $updates.0);
2441                                 spendable_outputs.append(&mut $updates.1);
2442                                 watch_outputs.append(&mut $updates.2);
2443                                 for claim in $updates.3 {
2444                                         match self.pending_claim_requests.entry(claim.0) {
2445                                                 hash_map::Entry::Occupied(_) => {},
2446                                                 hash_map::Entry::Vacant(entry) => { entry.insert(claim.1); }
2447                                         }
2448                                 }
2449                         }
2450                 }
2451
2452                 // HTLCs set may differ between last and previous local commitment txn, in case of one them hitting chain, ensure we cancel all HTLCs backward
2453                 let mut is_local_tx = false;
2454
2455                 if let &mut Some(ref mut local_tx) = &mut self.current_local_signed_commitment_tx {
2456                         if local_tx.txid == commitment_txid {
2457                                 match self.key_storage {
2458                                         Storage::Local { ref funding_key, .. } => {
2459                                                 local_tx.tx.add_local_sig(funding_key, self.funding_redeemscript.as_ref().unwrap(), self.channel_value_satoshis.unwrap(), &self.secp_ctx);
2460                                         },
2461                                         _ => {},
2462                                 }
2463                         }
2464                 }
2465                 if let &Some(ref local_tx) = &self.current_local_signed_commitment_tx {
2466                         if local_tx.txid == commitment_txid {
2467                                 is_local_tx = true;
2468                                 log_trace!(self, "Got latest local commitment tx broadcast, searching for available HTLCs to claim");
2469                                 assert!(local_tx.tx.has_local_sig());
2470                                 match self.key_storage {
2471                                         Storage::Local { ref delayed_payment_base_key, .. } => {
2472                                                 let mut res = self.broadcast_by_local_state(local_tx, delayed_payment_base_key, height);
2473                                                 append_onchain_update!(res);
2474                                         },
2475                                         Storage::Watchtower { .. } => { }
2476                                 }
2477                         }
2478                 }
2479                 if let &mut Some(ref mut local_tx) = &mut self.prev_local_signed_commitment_tx {
2480                         if local_tx.txid == commitment_txid {
2481                                 match self.key_storage {
2482                                         Storage::Local { ref funding_key, .. } => {
2483                                                 local_tx.tx.add_local_sig(funding_key, self.funding_redeemscript.as_ref().unwrap(), self.channel_value_satoshis.unwrap(), &self.secp_ctx);
2484                                         },
2485                                         _ => {},
2486                                 }
2487                         }
2488                 }
2489                 if let &Some(ref local_tx) = &self.prev_local_signed_commitment_tx {
2490                         if local_tx.txid == commitment_txid {
2491                                 is_local_tx = true;
2492                                 log_trace!(self, "Got previous local commitment tx broadcast, searching for available HTLCs to claim");
2493                                 assert!(local_tx.tx.has_local_sig());
2494                                 match self.key_storage {
2495                                         Storage::Local { ref delayed_payment_base_key, .. } => {
2496                                                 let mut res = self.broadcast_by_local_state(local_tx, delayed_payment_base_key, height);
2497                                                 append_onchain_update!(res);
2498                                         },
2499                                         Storage::Watchtower { .. } => { }
2500                                 }
2501                         }
2502                 }
2503
2504                 macro_rules! fail_dust_htlcs_after_threshold_conf {
2505                         ($local_tx: expr) => {
2506                                 for &(ref htlc, _, ref source) in &$local_tx.htlc_outputs {
2507                                         if htlc.transaction_output_index.is_none() {
2508                                                 if let &Some(ref source) = source {
2509                                                         wait_threshold_conf!(height, source.clone(), "lastest", htlc.payment_hash.clone());
2510                                                 }
2511                                         }
2512                                 }
2513                         }
2514                 }
2515
2516                 if is_local_tx {
2517                         if let &Some(ref local_tx) = &self.current_local_signed_commitment_tx {
2518                                 fail_dust_htlcs_after_threshold_conf!(local_tx);
2519                         }
2520                         if let &Some(ref local_tx) = &self.prev_local_signed_commitment_tx {
2521                                 fail_dust_htlcs_after_threshold_conf!(local_tx);
2522                         }
2523                 }
2524
2525                 (local_txn, spendable_outputs, (commitment_txid, watch_outputs))
2526         }
2527
2528         /// Generate a spendable output event when closing_transaction get registered onchain.
2529         fn check_spend_closing_transaction(&self, tx: &Transaction) -> Option<SpendableOutputDescriptor> {
2530                 if tx.input[0].sequence == 0xFFFFFFFF && !tx.input[0].witness.is_empty() && tx.input[0].witness.last().unwrap().len() == 71 {
2531                         match self.key_storage {
2532                                 Storage::Local { ref shutdown_pubkey, .. } =>  {
2533                                         let our_channel_close_key_hash = Hash160::hash(&shutdown_pubkey.serialize());
2534                                         let shutdown_script = Builder::new().push_opcode(opcodes::all::OP_PUSHBYTES_0).push_slice(&our_channel_close_key_hash[..]).into_script();
2535                                         for (idx, output) in tx.output.iter().enumerate() {
2536                                                 if shutdown_script == output.script_pubkey {
2537                                                         return Some(SpendableOutputDescriptor::StaticOutput {
2538                                                                 outpoint: BitcoinOutPoint { txid: tx.txid(), vout: idx as u32 },
2539                                                                 output: output.clone(),
2540                                                         });
2541                                                 }
2542                                         }
2543                                 }
2544                                 Storage::Watchtower { .. } => {
2545                                         //TODO: we need to ensure an offline client will generate the event when it
2546                                         // comes back online after only the watchtower saw the transaction
2547                                 }
2548                         }
2549                 }
2550                 None
2551         }
2552
2553         /// Used by ChannelManager deserialization to broadcast the latest local state if its copy of
2554         /// the Channel was out-of-date. You may use it to get a broadcastable local toxic tx in case of
2555         /// fallen-behind, i.e when receiving a channel_reestablish with a proof that our remote side knows
2556         /// a higher revocation secret than the local commitment number we are aware of. Broadcasting these
2557         /// transactions are UNSAFE, as they allow remote side to punish you. Nevertheless you may want to
2558         /// broadcast them if remote don't close channel with his higher commitment transaction after a
2559         /// substantial amount of time (a month or even a year) to get back funds. Best may be to contact
2560         /// out-of-band the other node operator to coordinate with him if option is available to you.
2561         /// In any-case, choice is up to the user.
2562         pub fn get_latest_local_commitment_txn(&mut self) -> Vec<Transaction> {
2563                 log_trace!(self, "Getting signed latest local commitment transaction!");
2564                 if let &mut Some(ref mut local_tx) = &mut self.current_local_signed_commitment_tx {
2565                         match self.key_storage {
2566                                 Storage::Local { ref funding_key, .. } => {
2567                                         local_tx.tx.add_local_sig(funding_key, self.funding_redeemscript.as_ref().unwrap(), self.channel_value_satoshis.unwrap(), &self.secp_ctx);
2568                                 },
2569                                 _ => {},
2570                         }
2571                 }
2572                 if let &Some(ref local_tx) = &self.current_local_signed_commitment_tx {
2573                         let mut res = vec![local_tx.tx.with_valid_witness().clone()];
2574                         match self.key_storage {
2575                                 Storage::Local { ref delayed_payment_base_key, .. } => {
2576                                         res.append(&mut self.broadcast_by_local_state(local_tx, delayed_payment_base_key, 0).0);
2577                                         // We throw away the generated waiting_first_conf data as we aren't (yet) confirmed and we don't actually know what the caller wants to do.
2578                                         // The data will be re-generated and tracked in check_spend_local_transaction if we get a confirmation.
2579                                 },
2580                                 _ => panic!("Can only broadcast by local channelmonitor"),
2581                         };
2582                         res
2583                 } else {
2584                         Vec::new()
2585                 }
2586         }
2587
2588         /// Called by SimpleManyChannelMonitor::block_connected, which implements
2589         /// ChainListener::block_connected.
2590         /// Eventually this should be pub and, roughly, implement ChainListener, however this requires
2591         /// &mut self, as well as returns new spendable outputs and outpoints to watch for spending of
2592         /// on-chain.
2593         fn block_connected<B: Deref>(&mut self, txn_matched: &[&Transaction], height: u32, block_hash: &Sha256dHash, broadcaster: B, fee_estimator: &FeeEstimator)-> (Vec<(Sha256dHash, Vec<TxOut>)>, Vec<SpendableOutputDescriptor>)
2594                 where B::Target: BroadcasterInterface
2595         {
2596                 for tx in txn_matched {
2597                         let mut output_val = 0;
2598                         for out in tx.output.iter() {
2599                                 if out.value > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
2600                                 output_val += out.value;
2601                                 if output_val > 21_000_000_0000_0000 { panic!("Value-overflowing transaction provided to block connected"); }
2602                         }
2603                 }
2604
2605                 log_trace!(self, "Block {} at height {} connected with {} txn matched", block_hash, height, txn_matched.len());
2606                 let mut watch_outputs = Vec::new();
2607                 let mut spendable_outputs = Vec::new();
2608                 let mut bump_candidates = HashSet::new();
2609                 for tx in txn_matched {
2610                         if tx.input.len() == 1 {
2611                                 // Assuming our keys were not leaked (in which case we're screwed no matter what),
2612                                 // commitment transactions and HTLC transactions will all only ever have one input,
2613                                 // which is an easy way to filter out any potential non-matching txn for lazy
2614                                 // filters.
2615                                 let prevout = &tx.input[0].previous_output;
2616                                 let mut txn: Vec<Transaction> = Vec::new();
2617                                 let funding_txo = match self.key_storage {
2618                                         Storage::Local { ref funding_info, .. } => {
2619                                                 funding_info.clone()
2620                                         }
2621                                         Storage::Watchtower { .. } => {
2622                                                 unimplemented!();
2623                                         }
2624                                 };
2625                                 if funding_txo.is_none() || (prevout.txid == funding_txo.as_ref().unwrap().0.txid && prevout.vout == funding_txo.as_ref().unwrap().0.index as u32) {
2626                                         if (tx.input[0].sequence >> 8*3) as u8 == 0x80 && (tx.lock_time >> 8*3) as u8 == 0x20 {
2627                                                 let (remote_txn, new_outputs, mut spendable_output) = self.check_spend_remote_transaction(&tx, height, fee_estimator);
2628                                                 txn = remote_txn;
2629                                                 spendable_outputs.append(&mut spendable_output);
2630                                                 if !new_outputs.1.is_empty() {
2631                                                         watch_outputs.push(new_outputs);
2632                                                 }
2633                                                 if txn.is_empty() {
2634                                                         let (local_txn, mut spendable_output, new_outputs) = self.check_spend_local_transaction(&tx, height);
2635                                                         spendable_outputs.append(&mut spendable_output);
2636                                                         txn = local_txn;
2637                                                         if !new_outputs.1.is_empty() {
2638                                                                 watch_outputs.push(new_outputs);
2639                                                         }
2640                                                 }
2641                                         }
2642                                         if !funding_txo.is_none() && txn.is_empty() {
2643                                                 if let Some(spendable_output) = self.check_spend_closing_transaction(&tx) {
2644                                                         spendable_outputs.push(spendable_output);
2645                                                 }
2646                                         }
2647                                 } else {
2648                                         if let Some(&(commitment_number, _)) = self.remote_commitment_txn_on_chain.get(&prevout.txid) {
2649                                                 let (tx, spendable_output) = self.check_spend_remote_htlc(&tx, commitment_number, height, fee_estimator);
2650                                                 if let Some(tx) = tx {
2651                                                         txn.push(tx);
2652                                                 }
2653                                                 if let Some(spendable_output) = spendable_output {
2654                                                         spendable_outputs.push(spendable_output);
2655                                                 }
2656                                         }
2657                                 }
2658                                 for tx in txn.iter() {
2659                                         log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
2660                                         broadcaster.broadcast_transaction(tx);
2661                                 }
2662                         }
2663                         // While all commitment/HTLC-Success/HTLC-Timeout transactions have one input, HTLCs
2664                         // can also be resolved in a few other ways which can have more than one output. Thus,
2665                         // we call is_resolving_htlc_output here outside of the tx.input.len() == 1 check.
2666                         self.is_resolving_htlc_output(&tx, height);
2667
2668                         // Scan all input to verify is one of the outpoint spent is of interest for us
2669                         let mut claimed_outputs_material = Vec::new();
2670                         for inp in &tx.input {
2671                                 if let Some(first_claim_txid_height) = self.claimable_outpoints.get(&inp.previous_output) {
2672                                         // If outpoint has claim request pending on it...
2673                                         if let Some(claim_material) = self.pending_claim_requests.get_mut(&first_claim_txid_height.0) {
2674                                                 //... we need to verify equality between transaction outpoints and claim request
2675                                                 // outpoints to know if transaction is the original claim or a bumped one issued
2676                                                 // by us.
2677                                                 let mut set_equality = true;
2678                                                 if claim_material.per_input_material.len() != tx.input.len() {
2679                                                         set_equality = false;
2680                                                 } else {
2681                                                         for (claim_inp, tx_inp) in claim_material.per_input_material.keys().zip(tx.input.iter()) {
2682                                                                 if *claim_inp != tx_inp.previous_output {
2683                                                                         set_equality = false;
2684                                                                 }
2685                                                         }
2686                                                 }
2687
2688                                                 macro_rules! clean_claim_request_after_safety_delay {
2689                                                         () => {
2690                                                                 let new_event = OnchainEvent::Claim { claim_request: first_claim_txid_height.0.clone() };
2691                                                                 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
2692                                                                         hash_map::Entry::Occupied(mut entry) => {
2693                                                                                 if !entry.get().contains(&new_event) {
2694                                                                                         entry.get_mut().push(new_event);
2695                                                                                 }
2696                                                                         },
2697                                                                         hash_map::Entry::Vacant(entry) => {
2698                                                                                 entry.insert(vec![new_event]);
2699                                                                         }
2700                                                                 }
2701                                                         }
2702                                                 }
2703
2704                                                 // If this is our transaction (or our counterparty spent all the outputs
2705                                                 // before we could anyway with same inputs order than us), wait for
2706                                                 // ANTI_REORG_DELAY and clean the RBF tracking map.
2707                                                 if set_equality {
2708                                                         clean_claim_request_after_safety_delay!();
2709                                                 } else { // If false, generate new claim request with update outpoint set
2710                                                         for input in tx.input.iter() {
2711                                                                 if let Some(input_material) = claim_material.per_input_material.remove(&input.previous_output) {
2712                                                                         claimed_outputs_material.push((input.previous_output, input_material));
2713                                                                 }
2714                                                                 // If there are no outpoints left to claim in this request, drop it entirely after ANTI_REORG_DELAY.
2715                                                                 if claim_material.per_input_material.is_empty() {
2716                                                                         clean_claim_request_after_safety_delay!();
2717                                                                 }
2718                                                         }
2719                                                         //TODO: recompute soonest_timelock to avoid wasting a bit on fees
2720                                                         bump_candidates.insert(first_claim_txid_height.0.clone());
2721                                                 }
2722                                                 break; //No need to iterate further, either tx is our or their
2723                                         } else {
2724                                                 panic!("Inconsistencies between pending_claim_requests map and claimable_outpoints map");
2725                                         }
2726                                 }
2727                         }
2728                         for (outpoint, input_material) in claimed_outputs_material.drain(..) {
2729                                 let new_event = OnchainEvent::ContentiousOutpoint { outpoint, input_material };
2730                                 match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
2731                                         hash_map::Entry::Occupied(mut entry) => {
2732                                                 if !entry.get().contains(&new_event) {
2733                                                         entry.get_mut().push(new_event);
2734                                                 }
2735                                         },
2736                                         hash_map::Entry::Vacant(entry) => {
2737                                                 entry.insert(vec![new_event]);
2738                                         }
2739                                 }
2740                         }
2741                 }
2742                 let should_broadcast = if let Some(_) = self.current_local_signed_commitment_tx {
2743                         self.would_broadcast_at_height(height)
2744                 } else { false };
2745                 if let Some(ref mut cur_local_tx) = self.current_local_signed_commitment_tx {
2746                         if should_broadcast {
2747                                 match self.key_storage {
2748                                         Storage::Local { ref funding_key, .. } => {
2749                                                 cur_local_tx.tx.add_local_sig(funding_key, self.funding_redeemscript.as_ref().unwrap(), self.channel_value_satoshis.unwrap(), &self.secp_ctx);
2750                                         },
2751                                         _ => {}
2752                                 }
2753                         }
2754                 }
2755                 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
2756                         if should_broadcast {
2757                                 log_trace!(self, "Broadcast onchain {}", log_tx!(cur_local_tx.tx.with_valid_witness()));
2758                                 broadcaster.broadcast_transaction(&cur_local_tx.tx.with_valid_witness());
2759                                 match self.key_storage {
2760                                         Storage::Local { ref delayed_payment_base_key, .. } => {
2761                                                 let (txs, mut spendable_output, new_outputs, _) = self.broadcast_by_local_state(&cur_local_tx, delayed_payment_base_key, height);
2762                                                 spendable_outputs.append(&mut spendable_output);
2763                                                 if !new_outputs.is_empty() {
2764                                                         watch_outputs.push((cur_local_tx.txid.clone(), new_outputs));
2765                                                 }
2766                                                 for tx in txs {
2767                                                         log_trace!(self, "Broadcast onchain {}", log_tx!(tx));
2768                                                         broadcaster.broadcast_transaction(&tx);
2769                                                 }
2770                                         },
2771                                         Storage::Watchtower { .. } => { },
2772                                 }
2773                         }
2774                 }
2775                 if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&height) {
2776                         for ev in events {
2777                                 match ev {
2778                                         OnchainEvent::Claim { claim_request } => {
2779                                                 // We may remove a whole set of claim outpoints here, as these one may have
2780                                                 // been aggregated in a single tx and claimed so atomically
2781                                                 if let Some(bump_material) = self.pending_claim_requests.remove(&claim_request) {
2782                                                         for outpoint in bump_material.per_input_material.keys() {
2783                                                                 self.claimable_outpoints.remove(&outpoint);
2784                                                         }
2785                                                 }
2786                                         },
2787                                         OnchainEvent::HTLCUpdate { htlc_update } => {
2788                                                 log_trace!(self, "HTLC {} failure update has got enough confirmations to be passed upstream", log_bytes!((htlc_update.1).0));
2789                                                 self.pending_htlcs_updated.push(HTLCUpdate {
2790                                                         payment_hash: htlc_update.1,
2791                                                         payment_preimage: None,
2792                                                         source: htlc_update.0,
2793                                                 });
2794                                         },
2795                                         OnchainEvent::ContentiousOutpoint { outpoint, .. } => {
2796                                                 self.claimable_outpoints.remove(&outpoint);
2797                                         }
2798                                 }
2799                         }
2800                 }
2801                 for (first_claim_txid, ref mut cached_claim_datas) in self.pending_claim_requests.iter_mut() {
2802                         if cached_claim_datas.height_timer == height {
2803                                 bump_candidates.insert(first_claim_txid.clone());
2804                         }
2805                 }
2806                 for first_claim_txid in bump_candidates.iter() {
2807                         if let Some((new_timer, new_feerate)) = {
2808                                 if let Some(claim_material) = self.pending_claim_requests.get(first_claim_txid) {
2809                                         if let Some((new_timer, new_feerate, bump_tx)) = self.bump_claim_tx(height, &claim_material, fee_estimator) {
2810                                                 broadcaster.broadcast_transaction(&bump_tx);
2811                                                 Some((new_timer, new_feerate))
2812                                         } else { None }
2813                                 } else { unreachable!(); }
2814                         } {
2815                                 if let Some(claim_material) = self.pending_claim_requests.get_mut(first_claim_txid) {
2816                                         claim_material.height_timer = new_timer;
2817                                         claim_material.feerate_previous = new_feerate;
2818                                 } else { unreachable!(); }
2819                         }
2820                 }
2821                 self.last_block_hash = block_hash.clone();
2822                 for &(ref txid, ref output_scripts) in watch_outputs.iter() {
2823                         self.outputs_to_watch.insert(txid.clone(), output_scripts.iter().map(|o| o.script_pubkey.clone()).collect());
2824                 }
2825                 (watch_outputs, spendable_outputs)
2826         }
2827
2828         fn block_disconnected<B: Deref>(&mut self, height: u32, block_hash: &Sha256dHash, broadcaster: B, fee_estimator: &FeeEstimator)
2829                 where B::Target: BroadcasterInterface
2830         {
2831                 log_trace!(self, "Block {} at height {} disconnected", block_hash, height);
2832                 let mut bump_candidates = HashMap::new();
2833                 if let Some(events) = self.onchain_events_waiting_threshold_conf.remove(&(height + ANTI_REORG_DELAY - 1)) {
2834                         //We may discard:
2835                         //- htlc update there as failure-trigger tx (revoked commitment tx, non-revoked commitment tx, HTLC-timeout tx) has been disconnected
2836                         //- our claim tx on a commitment tx output
2837                         //- resurect outpoint back in its claimable set and regenerate tx
2838                         for ev in events {
2839                                 match ev {
2840                                         OnchainEvent::ContentiousOutpoint { outpoint, input_material } => {
2841                                                 if let Some(ancestor_claimable_txid) = self.claimable_outpoints.get(&outpoint) {
2842                                                         if let Some(claim_material) = self.pending_claim_requests.get_mut(&ancestor_claimable_txid.0) {
2843                                                                 claim_material.per_input_material.insert(outpoint, input_material);
2844                                                                 // Using a HashMap guarantee us than if we have multiple outpoints getting
2845                                                                 // resurrected only one bump claim tx is going to be broadcast
2846                                                                 bump_candidates.insert(ancestor_claimable_txid.clone(), claim_material.clone());
2847                                                         }
2848                                                 }
2849                                         },
2850                                         _ => {},
2851                                 }
2852                         }
2853                 }
2854                 for (_, claim_material) in bump_candidates.iter_mut() {
2855                         if let Some((new_timer, new_feerate, bump_tx)) = self.bump_claim_tx(height, &claim_material, fee_estimator) {
2856                                 claim_material.height_timer = new_timer;
2857                                 claim_material.feerate_previous = new_feerate;
2858                                 broadcaster.broadcast_transaction(&bump_tx);
2859                         }
2860                 }
2861                 for (ancestor_claim_txid, claim_material) in bump_candidates.drain() {
2862                         self.pending_claim_requests.insert(ancestor_claim_txid.0, claim_material);
2863                 }
2864                 //TODO: if we implement cross-block aggregated claim transaction we need to refresh set of outpoints and regenerate tx but
2865                 // right now if one of the outpoint get disconnected, just erase whole pending claim request.
2866                 let mut remove_request = Vec::new();
2867                 self.claimable_outpoints.retain(|_, ref v|
2868                         if v.1 == height {
2869                         remove_request.push(v.0.clone());
2870                         false
2871                         } else { true });
2872                 for req in remove_request {
2873                         self.pending_claim_requests.remove(&req);
2874                 }
2875                 self.last_block_hash = block_hash.clone();
2876         }
2877
2878         pub(super) fn would_broadcast_at_height(&self, height: u32) -> bool {
2879                 // We need to consider all HTLCs which are:
2880                 //  * in any unrevoked remote commitment transaction, as they could broadcast said
2881                 //    transactions and we'd end up in a race, or
2882                 //  * are in our latest local commitment transaction, as this is the thing we will
2883                 //    broadcast if we go on-chain.
2884                 // Note that we consider HTLCs which were below dust threshold here - while they don't
2885                 // strictly imply that we need to fail the channel, we need to go ahead and fail them back
2886                 // to the source, and if we don't fail the channel we will have to ensure that the next
2887                 // updates that peer sends us are update_fails, failing the channel if not. It's probably
2888                 // easier to just fail the channel as this case should be rare enough anyway.
2889                 macro_rules! scan_commitment {
2890                         ($htlcs: expr, $local_tx: expr) => {
2891                                 for ref htlc in $htlcs {
2892                                         // For inbound HTLCs which we know the preimage for, we have to ensure we hit the
2893                                         // chain with enough room to claim the HTLC without our counterparty being able to
2894                                         // time out the HTLC first.
2895                                         // For outbound HTLCs which our counterparty hasn't failed/claimed, our primary
2896                                         // concern is being able to claim the corresponding inbound HTLC (on another
2897                                         // channel) before it expires. In fact, we don't even really care if our
2898                                         // counterparty here claims such an outbound HTLC after it expired as long as we
2899                                         // can still claim the corresponding HTLC. Thus, to avoid needlessly hitting the
2900                                         // chain when our counterparty is waiting for expiration to off-chain fail an HTLC
2901                                         // we give ourselves a few blocks of headroom after expiration before going
2902                                         // on-chain for an expired HTLC.
2903                                         // Note that, to avoid a potential attack whereby a node delays claiming an HTLC
2904                                         // from us until we've reached the point where we go on-chain with the
2905                                         // corresponding inbound HTLC, we must ensure that outbound HTLCs go on chain at
2906                                         // least CLTV_CLAIM_BUFFER blocks prior to the inbound HTLC.
2907                                         //  aka outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS == height - CLTV_CLAIM_BUFFER
2908                                         //      inbound_cltv == height + CLTV_CLAIM_BUFFER
2909                                         //      outbound_cltv + LATENCY_GRACE_PERIOD_BLOCKS + CLTV_CLAIM_BUFFER <= inbound_cltv - CLTV_CLAIM_BUFFER
2910                                         //      LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= inbound_cltv - outbound_cltv
2911                                         //      CLTV_EXPIRY_DELTA <= inbound_cltv - outbound_cltv (by check in ChannelManager::decode_update_add_htlc_onion)
2912                                         //      LATENCY_GRACE_PERIOD_BLOCKS + 2*CLTV_CLAIM_BUFFER <= CLTV_EXPIRY_DELTA
2913                                         //  The final, above, condition is checked for statically in channelmanager
2914                                         //  with CHECK_CLTV_EXPIRY_SANITY_2.
2915                                         let htlc_outbound = $local_tx == htlc.offered;
2916                                         if ( htlc_outbound && htlc.cltv_expiry + LATENCY_GRACE_PERIOD_BLOCKS <= height) ||
2917                                            (!htlc_outbound && htlc.cltv_expiry <= height + CLTV_CLAIM_BUFFER && self.payment_preimages.contains_key(&htlc.payment_hash)) {
2918                                                 log_info!(self, "Force-closing channel due to {} HTLC timeout, HTLC expiry is {}", if htlc_outbound { "outbound" } else { "inbound "}, htlc.cltv_expiry);
2919                                                 return true;
2920                                         }
2921                                 }
2922                         }
2923                 }
2924
2925                 if let Some(ref cur_local_tx) = self.current_local_signed_commitment_tx {
2926                         scan_commitment!(cur_local_tx.htlc_outputs.iter().map(|&(ref a, _, _)| a), true);
2927                 }
2928
2929                 if let Storage::Local { ref current_remote_commitment_txid, ref prev_remote_commitment_txid, .. } = self.key_storage {
2930                         if let &Some(ref txid) = current_remote_commitment_txid {
2931                                 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
2932                                         scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2933                                 }
2934                         }
2935                         if let &Some(ref txid) = prev_remote_commitment_txid {
2936                                 if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(txid) {
2937                                         scan_commitment!(htlc_outputs.iter().map(|&(ref a, _)| a), false);
2938                                 }
2939                         }
2940                 }
2941
2942                 false
2943         }
2944
2945         /// Check if any transaction broadcasted is resolving HTLC output by a success or timeout on a local
2946         /// or remote commitment tx, if so send back the source, preimage if found and payment_hash of resolved HTLC
2947         fn is_resolving_htlc_output(&mut self, tx: &Transaction, height: u32) {
2948                 'outer_loop: for input in &tx.input {
2949                         let mut payment_data = None;
2950                         let revocation_sig_claim = (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC) && input.witness[1].len() == 33)
2951                                 || (input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::AcceptedHTLC) && input.witness[1].len() == 33);
2952                         let accepted_preimage_claim = input.witness.len() == 5 && HTLCType::scriptlen_to_htlctype(input.witness[4].len()) == Some(HTLCType::AcceptedHTLC);
2953                         let offered_preimage_claim = input.witness.len() == 3 && HTLCType::scriptlen_to_htlctype(input.witness[2].len()) == Some(HTLCType::OfferedHTLC);
2954
2955                         macro_rules! log_claim {
2956                                 ($tx_info: expr, $local_tx: expr, $htlc: expr, $source_avail: expr) => {
2957                                         // We found the output in question, but aren't failing it backwards
2958                                         // as we have no corresponding source and no valid remote commitment txid
2959                                         // to try a weak source binding with same-hash, same-value still-valid offered HTLC.
2960                                         // This implies either it is an inbound HTLC or an outbound HTLC on a revoked transaction.
2961                                         let outbound_htlc = $local_tx == $htlc.offered;
2962                                         if ($local_tx && revocation_sig_claim) ||
2963                                                         (outbound_htlc && !$source_avail && (accepted_preimage_claim || offered_preimage_claim)) {
2964                                                 log_error!(self, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}!",
2965                                                         $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2966                                                         if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2967                                                         if revocation_sig_claim { "revocation sig" } else { "preimage claim after we'd passed the HTLC resolution back" });
2968                                         } else {
2969                                                 log_info!(self, "Input spending {} ({}:{}) in {} resolves {} HTLC with payment hash {} with {}",
2970                                                         $tx_info, input.previous_output.txid, input.previous_output.vout, tx.txid(),
2971                                                         if outbound_htlc { "outbound" } else { "inbound" }, log_bytes!($htlc.payment_hash.0),
2972                                                         if revocation_sig_claim { "revocation sig" } else if accepted_preimage_claim || offered_preimage_claim { "preimage" } else { "timeout" });
2973                                         }
2974                                 }
2975                         }
2976
2977                         macro_rules! check_htlc_valid_remote {
2978                                 ($remote_txid: expr, $htlc_output: expr) => {
2979                                         if let &Some(txid) = $remote_txid {
2980                                                 for &(ref pending_htlc, ref pending_source) in self.remote_claimable_outpoints.get(&txid).unwrap() {
2981                                                         if pending_htlc.payment_hash == $htlc_output.payment_hash && pending_htlc.amount_msat == $htlc_output.amount_msat {
2982                                                                 if let &Some(ref source) = pending_source {
2983                                                                         log_claim!("revoked remote commitment tx", false, pending_htlc, true);
2984                                                                         payment_data = Some(((**source).clone(), $htlc_output.payment_hash));
2985                                                                         break;
2986                                                                 }
2987                                                         }
2988                                                 }
2989                                         }
2990                                 }
2991                         }
2992
2993                         macro_rules! scan_commitment {
2994                                 ($htlcs: expr, $tx_info: expr, $local_tx: expr) => {
2995                                         for (ref htlc_output, source_option) in $htlcs {
2996                                                 if Some(input.previous_output.vout) == htlc_output.transaction_output_index {
2997                                                         if let Some(ref source) = source_option {
2998                                                                 log_claim!($tx_info, $local_tx, htlc_output, true);
2999                                                                 // We have a resolution of an HTLC either from one of our latest
3000                                                                 // local commitment transactions or an unrevoked remote commitment
3001                                                                 // transaction. This implies we either learned a preimage, the HTLC
3002                                                                 // has timed out, or we screwed up. In any case, we should now
3003                                                                 // resolve the source HTLC with the original sender.
3004                                                                 payment_data = Some(((*source).clone(), htlc_output.payment_hash));
3005                                                         } else if !$local_tx {
3006                                                                 if let Storage::Local { ref current_remote_commitment_txid, .. } = self.key_storage {
3007                                                                         check_htlc_valid_remote!(current_remote_commitment_txid, htlc_output);
3008                                                                 }
3009                                                                 if payment_data.is_none() {
3010                                                                         if let Storage::Local { ref prev_remote_commitment_txid, .. } = self.key_storage {
3011                                                                                 check_htlc_valid_remote!(prev_remote_commitment_txid, htlc_output);
3012                                                                         }
3013                                                                 }
3014                                                         }
3015                                                         if payment_data.is_none() {
3016                                                                 log_claim!($tx_info, $local_tx, htlc_output, false);
3017                                                                 continue 'outer_loop;
3018                                                         }
3019                                                 }
3020                                         }
3021                                 }
3022                         }
3023
3024                         if let Some(ref current_local_signed_commitment_tx) = self.current_local_signed_commitment_tx {
3025                                 if input.previous_output.txid == current_local_signed_commitment_tx.txid {
3026                                         scan_commitment!(current_local_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3027                                                 "our latest local commitment tx", true);
3028                                 }
3029                         }
3030                         if let Some(ref prev_local_signed_commitment_tx) = self.prev_local_signed_commitment_tx {
3031                                 if input.previous_output.txid == prev_local_signed_commitment_tx.txid {
3032                                         scan_commitment!(prev_local_signed_commitment_tx.htlc_outputs.iter().map(|&(ref a, _, ref b)| (a, b.as_ref())),
3033                                                 "our previous local commitment tx", true);
3034                                 }
3035                         }
3036                         if let Some(ref htlc_outputs) = self.remote_claimable_outpoints.get(&input.previous_output.txid) {
3037                                 scan_commitment!(htlc_outputs.iter().map(|&(ref a, ref b)| (a, (b.as_ref().clone()).map(|boxed| &**boxed))),
3038                                         "remote commitment tx", false);
3039                         }
3040
3041                         // Check that scan_commitment, above, decided there is some source worth relaying an
3042                         // HTLC resolution backwards to and figure out whether we learned a preimage from it.
3043                         if let Some((source, payment_hash)) = payment_data {
3044                                 let mut payment_preimage = PaymentPreimage([0; 32]);
3045                                 if accepted_preimage_claim {
3046                                         payment_preimage.0.copy_from_slice(&input.witness[3]);
3047                                         self.pending_htlcs_updated.push(HTLCUpdate {
3048                                                 source,
3049                                                 payment_preimage: Some(payment_preimage),
3050                                                 payment_hash
3051                                         });
3052                                 } else if offered_preimage_claim {
3053                                         payment_preimage.0.copy_from_slice(&input.witness[1]);
3054                                         self.pending_htlcs_updated.push(HTLCUpdate {
3055                                                 source,
3056                                                 payment_preimage: Some(payment_preimage),
3057                                                 payment_hash
3058                                         });
3059                                 } else {
3060                                         log_info!(self, "Failing HTLC with payment_hash {} timeout by a spend tx, waiting for confirmation (at height{})", log_bytes!(payment_hash.0), height + ANTI_REORG_DELAY - 1);
3061                                         match self.onchain_events_waiting_threshold_conf.entry(height + ANTI_REORG_DELAY - 1) {
3062                                                 hash_map::Entry::Occupied(mut entry) => {
3063                                                         let e = entry.get_mut();
3064                                                         e.retain(|ref event| {
3065                                                                 match **event {
3066                                                                         OnchainEvent::HTLCUpdate { ref htlc_update } => {
3067                                                                                 return htlc_update.0 != source
3068                                                                         },
3069                                                                         _ => return true
3070                                                                 }
3071                                                         });
3072                                                         e.push(OnchainEvent::HTLCUpdate { htlc_update: (source, payment_hash)});
3073                                                 }
3074                                                 hash_map::Entry::Vacant(entry) => {
3075                                                         entry.insert(vec![OnchainEvent::HTLCUpdate { htlc_update: (source, payment_hash)}]);
3076                                                 }
3077                                         }
3078                                 }
3079                         }
3080                 }
3081         }
3082
3083         /// Lightning security model (i.e being able to redeem/timeout HTLC or penalize coutnerparty onchain) lays on the assumption of claim transactions getting confirmed before timelock expiration
3084         /// (CSV or CLTV following cases). In case of high-fee spikes, claim tx may stuck in the mempool, so you need to bump its feerate quickly using Replace-By-Fee or Child-Pay-For-Parent.
3085         fn bump_claim_tx(&self, height: u32, cached_claim_datas: &ClaimTxBumpMaterial, fee_estimator: &FeeEstimator) -> Option<(u32, u64, Transaction)> {
3086                 if cached_claim_datas.per_input_material.len() == 0 { return None } // But don't prune pending claiming request yet, we may have to resurrect HTLCs
3087                 let mut inputs = Vec::new();
3088                 for outp in cached_claim_datas.per_input_material.keys() {
3089                         inputs.push(TxIn {
3090                                 previous_output: *outp,
3091                                 script_sig: Script::new(),
3092                                 sequence: 0xfffffffd,
3093                                 witness: Vec::new(),
3094                         });
3095                 }
3096                 let mut bumped_tx = Transaction {
3097                         version: 2,
3098                         lock_time: 0,
3099                         input: inputs,
3100                         output: vec![TxOut {
3101                                 script_pubkey: self.destination_script.clone(),
3102                                 value: 0
3103                         }],
3104                 };
3105
3106                 macro_rules! RBF_bump {
3107                         ($amount: expr, $old_feerate: expr, $fee_estimator: expr, $predicted_weight: expr) => {
3108                                 {
3109                                         let mut used_feerate;
3110                                         // If old feerate inferior to actual one given back by Fee Estimator, use it to compute new fee...
3111                                         let new_fee = if $old_feerate < $fee_estimator.get_est_sat_per_1000_weight(ConfirmationTarget::HighPriority) {
3112                                                 let mut value = $amount;
3113                                                 if subtract_high_prio_fee!(self, $fee_estimator, value, $predicted_weight, used_feerate) {
3114                                                         // Overflow check is done in subtract_high_prio_fee
3115                                                         $amount - value
3116                                                 } else {
3117                                                         log_trace!(self, "Can't new-estimation bump new claiming tx, amount {} is too small", $amount);
3118                                                         return None;
3119                                                 }
3120                                         // ...else just increase the previous feerate by 25% (because that's a nice number)
3121                                         } else {
3122                                                 let fee = $old_feerate * $predicted_weight / 750;
3123                                                 if $amount <= fee {
3124                                                         log_trace!(self, "Can't 25% bump new claiming tx, amount {} is too small", $amount);
3125                                                         return None;
3126                                                 }
3127                                                 fee
3128                                         };
3129
3130                                         let previous_fee = $old_feerate * $predicted_weight / 1000;
3131                                         let min_relay_fee = MIN_RELAY_FEE_SAT_PER_1000_WEIGHT * $predicted_weight / 1000;
3132                                         // BIP 125 Opt-in Full Replace-by-Fee Signaling
3133                                         //      * 3. The replacement transaction pays an absolute fee of at least the sum paid by the original transactions.
3134                                         //      * 4. The replacement transaction must also pay for its own bandwidth at or above the rate set by the node's minimum relay fee setting.
3135                                         let new_fee = if new_fee < previous_fee + min_relay_fee {
3136                                                 new_fee + previous_fee + min_relay_fee - new_fee
3137                                         } else {
3138                                                 new_fee
3139                                         };
3140                                         Some((new_fee, new_fee * 1000 / $predicted_weight))
3141                                 }
3142                         }
3143                 }
3144
3145                 let new_timer = Self::get_height_timer(height, cached_claim_datas.soonest_timelock);
3146                 let mut inputs_witnesses_weight = 0;
3147                 let mut amt = 0;
3148                 for per_outp_material in cached_claim_datas.per_input_material.values() {
3149                         match per_outp_material {
3150                                 &InputMaterial::Revoked { ref script, ref is_htlc, ref amount, .. } => {
3151                                         inputs_witnesses_weight += Self::get_witnesses_weight(if !is_htlc { &[InputDescriptors::RevokedOutput] } else if HTLCType::scriptlen_to_htlctype(script.len()) == Some(HTLCType::OfferedHTLC) { &[InputDescriptors::RevokedOfferedHTLC] } else if HTLCType::scriptlen_to_htlctype(script.len()) == Some(HTLCType::AcceptedHTLC) { &[InputDescriptors::RevokedReceivedHTLC] } else { unreachable!() });
3152                                         amt += *amount;
3153                                 },
3154                                 &InputMaterial::RemoteHTLC { ref preimage, ref amount, .. } => {
3155                                         inputs_witnesses_weight += Self::get_witnesses_weight(if preimage.is_some() { &[InputDescriptors::OfferedHTLC] } else { &[InputDescriptors::ReceivedHTLC] });
3156                                         amt += *amount;
3157                                 },
3158                                 &InputMaterial::LocalHTLC { .. } => { return None; }
3159                         }
3160                 }
3161
3162                 let predicted_weight = bumped_tx.get_weight() + inputs_witnesses_weight;
3163                 let new_feerate;
3164                 if let Some((new_fee, feerate)) = RBF_bump!(amt, cached_claim_datas.feerate_previous, fee_estimator, predicted_weight as u64) {
3165                         // If new computed fee is superior at the whole claimable amount burn all in fees
3166                         if new_fee > amt {
3167                                 bumped_tx.output[0].value = 0;
3168                         } else {
3169                                 bumped_tx.output[0].value = amt - new_fee;
3170                         }
3171                         new_feerate = feerate;
3172                 } else {
3173                         return None;
3174                 }
3175                 assert!(new_feerate != 0);
3176
3177                 for (i, (outp, per_outp_material)) in cached_claim_datas.per_input_material.iter().enumerate() {
3178                         match per_outp_material {
3179                                 &InputMaterial::Revoked { ref script, ref pubkey, ref key, ref is_htlc, ref amount } => {
3180                                         let sighash_parts = bip143::SighashComponents::new(&bumped_tx);
3181                                         let sighash = hash_to_message!(&sighash_parts.sighash_all(&bumped_tx.input[i], &script, *amount)[..]);
3182                                         let sig = self.secp_ctx.sign(&sighash, &key);
3183                                         bumped_tx.input[i].witness.push(sig.serialize_der().to_vec());
3184                                         bumped_tx.input[i].witness[0].push(SigHashType::All as u8);
3185                                         if *is_htlc {
3186                                                 bumped_tx.input[i].witness.push(pubkey.unwrap().clone().serialize().to_vec());
3187                                         } else {
3188                                                 bumped_tx.input[i].witness.push(vec!(1));
3189                                         }
3190                                         bumped_tx.input[i].witness.push(script.clone().into_bytes());
3191                                         log_trace!(self, "Going to broadcast bumped Penalty Transaction {} claiming revoked {} output {} from {} with new feerate {}", bumped_tx.txid(), if !is_htlc { "to_local" } else if HTLCType::scriptlen_to_htlctype(script.len()) == Some(HTLCType::OfferedHTLC) { "offered" } else if HTLCType::scriptlen_to_htlctype(script.len()) == Some(HTLCType::AcceptedHTLC) { "received" } else { "" }, outp.vout, outp.txid, new_feerate);
3192                                 },
3193                                 &InputMaterial::RemoteHTLC { ref script, ref key, ref preimage, ref amount, ref locktime } => {
3194                                         if !preimage.is_some() { bumped_tx.lock_time = *locktime };
3195                                         let sighash_parts = bip143::SighashComponents::new(&bumped_tx);
3196                                         let sighash = hash_to_message!(&sighash_parts.sighash_all(&bumped_tx.input[i], &script, *amount)[..]);
3197                                         let sig = self.secp_ctx.sign(&sighash, &key);
3198                                         bumped_tx.input[i].witness.push(sig.serialize_der().to_vec());
3199                                         bumped_tx.input[i].witness[0].push(SigHashType::All as u8);
3200                                         if let &Some(preimage) = preimage {
3201                                                 bumped_tx.input[i].witness.push(preimage.clone().0.to_vec());
3202                                         } else {
3203                                                 bumped_tx.input[i].witness.push(vec![0]);
3204                                         }
3205                                         bumped_tx.input[i].witness.push(script.clone().into_bytes());
3206                                         log_trace!(self, "Going to broadcast bumped Claim Transaction {} claiming remote {} htlc output {} from {} with new feerate {}", bumped_tx.txid(), if preimage.is_some() { "offered" } else { "received" }, outp.vout, outp.txid, new_feerate);
3207                                 },
3208                                 &InputMaterial::LocalHTLC { .. } => {
3209                                         //TODO : Given that Local Commitment Transaction and HTLC-Timeout/HTLC-Success are counter-signed by peer, we can't
3210                                         // RBF them. Need a Lightning specs change and package relay modification :
3211                                         // https://lists.linuxfoundation.org/pipermail/bitcoin-dev/2018-November/016518.html
3212                                         return None;
3213                                 }
3214                         }
3215                 }
3216                 assert!(predicted_weight >= bumped_tx.get_weight());
3217                 Some((new_timer, new_feerate, bumped_tx))
3218         }
3219 }
3220
3221 const MAX_ALLOC_SIZE: usize = 64*1024;
3222
3223 impl<R: ::std::io::Read, ChanSigner: ChannelKeys + Readable<R>> ReadableArgs<R, Arc<Logger>> for (Sha256dHash, ChannelMonitor<ChanSigner>) {
3224         fn read(reader: &mut R, logger: Arc<Logger>) -> Result<Self, DecodeError> {
3225                 let secp_ctx = Secp256k1::new();
3226                 macro_rules! unwrap_obj {
3227                         ($key: expr) => {
3228                                 match $key {
3229                                         Ok(res) => res,
3230                                         Err(_) => return Err(DecodeError::InvalidValue),
3231                                 }
3232                         }
3233                 }
3234
3235                 let _ver: u8 = Readable::read(reader)?;
3236                 let min_ver: u8 = Readable::read(reader)?;
3237                 if min_ver > SERIALIZATION_VERSION {
3238                         return Err(DecodeError::UnknownVersion);
3239                 }
3240
3241                 let latest_update_id: u64 = Readable::read(reader)?;
3242                 let commitment_transaction_number_obscure_factor = <U48 as Readable<R>>::read(reader)?.0;
3243
3244                 let key_storage = match <u8 as Readable<R>>::read(reader)? {
3245                         0 => {
3246                                 let keys = Readable::read(reader)?;
3247                                 let funding_key = Readable::read(reader)?;
3248                                 let revocation_base_key = Readable::read(reader)?;
3249                                 let htlc_base_key = Readable::read(reader)?;
3250                                 let delayed_payment_base_key = Readable::read(reader)?;
3251                                 let payment_base_key = Readable::read(reader)?;
3252                                 let shutdown_pubkey = Readable::read(reader)?;
3253                                 // Technically this can fail and serialize fail a round-trip, but only for serialization of
3254                                 // barely-init'd ChannelMonitors that we can't do anything with.
3255                                 let outpoint = OutPoint {
3256                                         txid: Readable::read(reader)?,
3257                                         index: Readable::read(reader)?,
3258                                 };
3259                                 let funding_info = Some((outpoint, Readable::read(reader)?));
3260                                 let current_remote_commitment_txid = Readable::read(reader)?;
3261                                 let prev_remote_commitment_txid = Readable::read(reader)?;
3262                                 Storage::Local {
3263                                         keys,
3264                                         funding_key,
3265                                         revocation_base_key,
3266                                         htlc_base_key,
3267                                         delayed_payment_base_key,
3268                                         payment_base_key,
3269                                         shutdown_pubkey,
3270                                         funding_info,
3271                                         current_remote_commitment_txid,
3272                                         prev_remote_commitment_txid,
3273                                 }
3274                         },
3275                         _ => return Err(DecodeError::InvalidValue),
3276                 };
3277
3278                 let their_htlc_base_key = Some(Readable::read(reader)?);
3279                 let their_delayed_payment_base_key = Some(Readable::read(reader)?);
3280                 let funding_redeemscript = Some(Readable::read(reader)?);
3281                 let channel_value_satoshis = Some(Readable::read(reader)?);
3282
3283                 let their_cur_revocation_points = {
3284                         let first_idx = <U48 as Readable<R>>::read(reader)?.0;
3285                         if first_idx == 0 {
3286                                 None
3287                         } else {
3288                                 let first_point = Readable::read(reader)?;
3289                                 let second_point_slice: [u8; 33] = Readable::read(reader)?;
3290                                 if second_point_slice[0..32] == [0; 32] && second_point_slice[32] == 0 {
3291                                         Some((first_idx, first_point, None))
3292                                 } else {
3293                                         Some((first_idx, first_point, Some(unwrap_obj!(PublicKey::from_slice(&second_point_slice)))))
3294                                 }
3295                         }
3296                 };
3297
3298                 let our_to_self_delay: u16 = Readable::read(reader)?;
3299                 let their_to_self_delay: Option<u16> = Some(Readable::read(reader)?);
3300
3301                 let commitment_secrets = Readable::read(reader)?;
3302
3303                 macro_rules! read_htlc_in_commitment {
3304                         () => {
3305                                 {
3306                                         let offered: bool = Readable::read(reader)?;
3307                                         let amount_msat: u64 = Readable::read(reader)?;
3308                                         let cltv_expiry: u32 = Readable::read(reader)?;
3309                                         let payment_hash: PaymentHash = Readable::read(reader)?;
3310                                         let transaction_output_index: Option<u32> = Readable::read(reader)?;
3311
3312                                         HTLCOutputInCommitment {
3313                                                 offered, amount_msat, cltv_expiry, payment_hash, transaction_output_index
3314                                         }
3315                                 }
3316                         }
3317                 }
3318
3319                 let remote_claimable_outpoints_len: u64 = Readable::read(reader)?;
3320                 let mut remote_claimable_outpoints = HashMap::with_capacity(cmp::min(remote_claimable_outpoints_len as usize, MAX_ALLOC_SIZE / 64));
3321                 for _ in 0..remote_claimable_outpoints_len {
3322                         let txid: Sha256dHash = Readable::read(reader)?;
3323                         let htlcs_count: u64 = Readable::read(reader)?;
3324                         let mut htlcs = Vec::with_capacity(cmp::min(htlcs_count as usize, MAX_ALLOC_SIZE / 32));
3325                         for _ in 0..htlcs_count {
3326                                 htlcs.push((read_htlc_in_commitment!(), <Option<HTLCSource> as Readable<R>>::read(reader)?.map(|o: HTLCSource| Box::new(o))));
3327                         }
3328                         if let Some(_) = remote_claimable_outpoints.insert(txid, htlcs) {
3329                                 return Err(DecodeError::InvalidValue);
3330                         }
3331                 }
3332
3333                 let remote_commitment_txn_on_chain_len: u64 = Readable::read(reader)?;
3334                 let mut remote_commitment_txn_on_chain = HashMap::with_capacity(cmp::min(remote_commitment_txn_on_chain_len as usize, MAX_ALLOC_SIZE / 32));
3335                 for _ in 0..remote_commitment_txn_on_chain_len {
3336                         let txid: Sha256dHash = Readable::read(reader)?;
3337                         let commitment_number = <U48 as Readable<R>>::read(reader)?.0;
3338                         let outputs_count = <u64 as Readable<R>>::read(reader)?;
3339                         let mut outputs = Vec::with_capacity(cmp::min(outputs_count as usize, MAX_ALLOC_SIZE / 8));
3340                         for _ in 0..outputs_count {
3341                                 outputs.push(Readable::read(reader)?);
3342                         }
3343                         if let Some(_) = remote_commitment_txn_on_chain.insert(txid, (commitment_number, outputs)) {
3344                                 return Err(DecodeError::InvalidValue);
3345                         }
3346                 }
3347
3348                 let remote_hash_commitment_number_len: u64 = Readable::read(reader)?;
3349                 let mut remote_hash_commitment_number = HashMap::with_capacity(cmp::min(remote_hash_commitment_number_len as usize, MAX_ALLOC_SIZE / 32));
3350                 for _ in 0..remote_hash_commitment_number_len {
3351                         let payment_hash: PaymentHash = Readable::read(reader)?;
3352                         let commitment_number = <U48 as Readable<R>>::read(reader)?.0;
3353                         if let Some(_) = remote_hash_commitment_number.insert(payment_hash, commitment_number) {
3354                                 return Err(DecodeError::InvalidValue);
3355                         }
3356                 }
3357
3358                 macro_rules! read_local_tx {
3359                         () => {
3360                                 {
3361                                         let tx = <LocalCommitmentTransaction as Readable<R>>::read(reader)?;
3362                                         let revocation_key = Readable::read(reader)?;
3363                                         let a_htlc_key = Readable::read(reader)?;
3364                                         let b_htlc_key = Readable::read(reader)?;
3365                                         let delayed_payment_key = Readable::read(reader)?;
3366                                         let per_commitment_point = Readable::read(reader)?;
3367                                         let feerate_per_kw: u64 = Readable::read(reader)?;
3368
3369                                         let htlcs_len: u64 = Readable::read(reader)?;
3370                                         let mut htlcs = Vec::with_capacity(cmp::min(htlcs_len as usize, MAX_ALLOC_SIZE / 128));
3371                                         for _ in 0..htlcs_len {
3372                                                 let htlc = read_htlc_in_commitment!();
3373                                                 let sigs = match <u8 as Readable<R>>::read(reader)? {
3374                                                         0 => None,
3375                                                         1 => Some(Readable::read(reader)?),
3376                                                         _ => return Err(DecodeError::InvalidValue),
3377                                                 };
3378                                                 htlcs.push((htlc, sigs, Readable::read(reader)?));
3379                                         }
3380
3381                                         LocalSignedTx {
3382                                                 txid: tx.txid(),
3383                                                 tx, revocation_key, a_htlc_key, b_htlc_key, delayed_payment_key, per_commitment_point, feerate_per_kw,
3384                                                 htlc_outputs: htlcs
3385                                         }
3386                                 }
3387                         }
3388                 }
3389
3390                 let prev_local_signed_commitment_tx = match <u8 as Readable<R>>::read(reader)? {
3391                         0 => None,
3392                         1 => {
3393                                 Some(read_local_tx!())
3394                         },
3395                         _ => return Err(DecodeError::InvalidValue),
3396                 };
3397
3398                 let current_local_signed_commitment_tx = match <u8 as Readable<R>>::read(reader)? {
3399                         0 => None,
3400                         1 => {
3401                                 Some(read_local_tx!())
3402                         },
3403                         _ => return Err(DecodeError::InvalidValue),
3404                 };
3405
3406                 let current_remote_commitment_number = <U48 as Readable<R>>::read(reader)?.0;
3407
3408                 let payment_preimages_len: u64 = Readable::read(reader)?;
3409                 let mut payment_preimages = HashMap::with_capacity(cmp::min(payment_preimages_len as usize, MAX_ALLOC_SIZE / 32));
3410                 for _ in 0..payment_preimages_len {
3411                         let preimage: PaymentPreimage = Readable::read(reader)?;
3412                         let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
3413                         if let Some(_) = payment_preimages.insert(hash, preimage) {
3414                                 return Err(DecodeError::InvalidValue);
3415                         }
3416                 }
3417
3418                 let pending_htlcs_updated_len: u64 = Readable::read(reader)?;
3419                 let mut pending_htlcs_updated = Vec::with_capacity(cmp::min(pending_htlcs_updated_len as usize, MAX_ALLOC_SIZE / (32 + 8*3)));
3420                 for _ in 0..pending_htlcs_updated_len {
3421                         pending_htlcs_updated.push(Readable::read(reader)?);
3422                 }
3423
3424                 let last_block_hash: Sha256dHash = Readable::read(reader)?;
3425                 let destination_script = Readable::read(reader)?;
3426                 let to_remote_rescue = match <u8 as Readable<R>>::read(reader)? {
3427                         0 => None,
3428                         1 => {
3429                                 let to_remote_script = Readable::read(reader)?;
3430                                 let local_key = Readable::read(reader)?;
3431                                 Some((to_remote_script, local_key))
3432                         }
3433                         _ => return Err(DecodeError::InvalidValue),
3434                 };
3435
3436                 let pending_claim_requests_len: u64 = Readable::read(reader)?;
3437                 let mut pending_claim_requests = HashMap::with_capacity(cmp::min(pending_claim_requests_len as usize, MAX_ALLOC_SIZE / 128));
3438                 for _ in 0..pending_claim_requests_len {
3439                         pending_claim_requests.insert(Readable::read(reader)?, Readable::read(reader)?);
3440                 }
3441
3442                 let claimable_outpoints_len: u64 = Readable::read(reader)?;
3443                 let mut claimable_outpoints = HashMap::with_capacity(cmp::min(pending_claim_requests_len as usize, MAX_ALLOC_SIZE / 128));
3444                 for _ in 0..claimable_outpoints_len {
3445                         let outpoint = Readable::read(reader)?;
3446                         let ancestor_claim_txid = Readable::read(reader)?;
3447                         let height = Readable::read(reader)?;
3448                         claimable_outpoints.insert(outpoint, (ancestor_claim_txid, height));
3449                 }
3450
3451                 let waiting_threshold_conf_len: u64 = Readable::read(reader)?;
3452                 let mut onchain_events_waiting_threshold_conf = HashMap::with_capacity(cmp::min(waiting_threshold_conf_len as usize, MAX_ALLOC_SIZE / 128));
3453                 for _ in 0..waiting_threshold_conf_len {
3454                         let height_target = Readable::read(reader)?;
3455                         let events_len: u64 = Readable::read(reader)?;
3456                         let mut events = Vec::with_capacity(cmp::min(events_len as usize, MAX_ALLOC_SIZE / 128));
3457                         for _ in 0..events_len {
3458                                 let ev = match <u8 as Readable<R>>::read(reader)? {
3459                                         0 => {
3460                                                 let claim_request = Readable::read(reader)?;
3461                                                 OnchainEvent::Claim {
3462                                                         claim_request
3463                                                 }
3464                                         },
3465                                         1 => {
3466                                                 let htlc_source = Readable::read(reader)?;
3467                                                 let hash = Readable::read(reader)?;
3468                                                 OnchainEvent::HTLCUpdate {
3469                                                         htlc_update: (htlc_source, hash)
3470                                                 }
3471                                         },
3472                                         2 => {
3473                                                 let outpoint = Readable::read(reader)?;
3474                                                 let input_material = Readable::read(reader)?;
3475                                                 OnchainEvent::ContentiousOutpoint {
3476                                                         outpoint,
3477                                                         input_material
3478                                                 }
3479                                         }
3480                                         _ => return Err(DecodeError::InvalidValue),
3481                                 };
3482                                 events.push(ev);
3483                         }
3484                         onchain_events_waiting_threshold_conf.insert(height_target, events);
3485                 }
3486
3487                 let outputs_to_watch_len: u64 = Readable::read(reader)?;
3488                 let mut outputs_to_watch = HashMap::with_capacity(cmp::min(outputs_to_watch_len as usize, MAX_ALLOC_SIZE / (mem::size_of::<Sha256dHash>() + mem::size_of::<Vec<Script>>())));
3489                 for _ in 0..outputs_to_watch_len {
3490                         let txid = Readable::read(reader)?;
3491                         let outputs_len: u64 = Readable::read(reader)?;
3492                         let mut outputs = Vec::with_capacity(cmp::min(outputs_len as usize, MAX_ALLOC_SIZE / mem::size_of::<Script>()));
3493                         for _ in 0..outputs_len {
3494                                 outputs.push(Readable::read(reader)?);
3495                         }
3496                         if let Some(_) = outputs_to_watch.insert(txid, outputs) {
3497                                 return Err(DecodeError::InvalidValue);
3498                         }
3499                 }
3500
3501                 Ok((last_block_hash.clone(), ChannelMonitor {
3502                         latest_update_id,
3503                         commitment_transaction_number_obscure_factor,
3504
3505                         key_storage,
3506                         their_htlc_base_key,
3507                         their_delayed_payment_base_key,
3508                         funding_redeemscript,
3509                         channel_value_satoshis,
3510                         their_cur_revocation_points,
3511
3512                         our_to_self_delay,
3513                         their_to_self_delay,
3514
3515                         commitment_secrets,
3516                         remote_claimable_outpoints,
3517                         remote_commitment_txn_on_chain,
3518                         remote_hash_commitment_number,
3519
3520                         prev_local_signed_commitment_tx,
3521                         current_local_signed_commitment_tx,
3522                         current_remote_commitment_number,
3523
3524                         payment_preimages,
3525                         pending_htlcs_updated,
3526
3527                         destination_script,
3528                         to_remote_rescue,
3529
3530                         pending_claim_requests,
3531
3532                         claimable_outpoints,
3533
3534                         onchain_events_waiting_threshold_conf,
3535                         outputs_to_watch,
3536
3537                         last_block_hash,
3538                         secp_ctx,
3539                         logger,
3540                 }))
3541         }
3542
3543 }
3544
3545 #[cfg(test)]
3546 mod tests {
3547         use bitcoin::blockdata::script::{Script, Builder};
3548         use bitcoin::blockdata::opcodes;
3549         use bitcoin::blockdata::transaction::{Transaction, TxIn, TxOut, SigHashType};
3550         use bitcoin::blockdata::transaction::OutPoint as BitcoinOutPoint;
3551         use bitcoin::util::bip143;
3552         use bitcoin_hashes::Hash;
3553         use bitcoin_hashes::sha256::Hash as Sha256;
3554         use bitcoin_hashes::sha256d::Hash as Sha256dHash;
3555         use bitcoin_hashes::hex::FromHex;
3556         use hex;
3557         use chain::transaction::OutPoint;
3558         use ln::channelmanager::{PaymentPreimage, PaymentHash};
3559         use ln::channelmonitor::{ChannelMonitor, InputDescriptors};
3560         use ln::chan_utils;
3561         use ln::chan_utils::{HTLCOutputInCommitment, TxCreationKeys, LocalCommitmentTransaction};
3562         use util::test_utils::TestLogger;
3563         use secp256k1::key::{SecretKey,PublicKey};
3564         use secp256k1::Secp256k1;
3565         use rand::{thread_rng,Rng};
3566         use std::sync::Arc;
3567         use chain::keysinterface::InMemoryChannelKeys;
3568
3569         #[test]
3570         fn test_prune_preimages() {
3571                 let secp_ctx = Secp256k1::new();
3572                 let logger = Arc::new(TestLogger::new());
3573
3574                 let dummy_key = PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap());
3575                 macro_rules! dummy_keys {
3576                         () => {
3577                                 {
3578                                         TxCreationKeys {
3579                                                 per_commitment_point: dummy_key.clone(),
3580                                                 revocation_key: dummy_key.clone(),
3581                                                 a_htlc_key: dummy_key.clone(),
3582                                                 b_htlc_key: dummy_key.clone(),
3583                                                 a_delayed_payment_key: dummy_key.clone(),
3584                                                 b_payment_key: dummy_key.clone(),
3585                                         }
3586                                 }
3587                         }
3588                 }
3589                 let dummy_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
3590
3591                 let mut preimages = Vec::new();
3592                 {
3593                         let mut rng  = thread_rng();
3594                         for _ in 0..20 {
3595                                 let mut preimage = PaymentPreimage([0; 32]);
3596                                 rng.fill_bytes(&mut preimage.0[..]);
3597                                 let hash = PaymentHash(Sha256::hash(&preimage.0[..]).into_inner());
3598                                 preimages.push((preimage, hash));
3599                         }
3600                 }
3601
3602                 macro_rules! preimages_slice_to_htlc_outputs {
3603                         ($preimages_slice: expr) => {
3604                                 {
3605                                         let mut res = Vec::new();
3606                                         for (idx, preimage) in $preimages_slice.iter().enumerate() {
3607                                                 res.push((HTLCOutputInCommitment {
3608                                                         offered: true,
3609                                                         amount_msat: 0,
3610                                                         cltv_expiry: 0,
3611                                                         payment_hash: preimage.1.clone(),
3612                                                         transaction_output_index: Some(idx as u32),
3613                                                 }, None));
3614                                         }
3615                                         res
3616                                 }
3617                         }
3618                 }
3619                 macro_rules! preimages_to_local_htlcs {
3620                         ($preimages_slice: expr) => {
3621                                 {
3622                                         let mut inp = preimages_slice_to_htlc_outputs!($preimages_slice);
3623                                         let res: Vec<_> = inp.drain(..).map(|e| { (e.0, None, e.1) }).collect();
3624                                         res
3625                                 }
3626                         }
3627                 }
3628
3629                 macro_rules! test_preimages_exist {
3630                         ($preimages_slice: expr, $monitor: expr) => {
3631                                 for preimage in $preimages_slice {
3632                                         assert!($monitor.payment_preimages.contains_key(&preimage.1));
3633                                 }
3634                         }
3635                 }
3636
3637                 let keys = InMemoryChannelKeys::new(
3638                         &secp_ctx,
3639                         SecretKey::from_slice(&[41; 32]).unwrap(),
3640                         SecretKey::from_slice(&[41; 32]).unwrap(),
3641                         SecretKey::from_slice(&[41; 32]).unwrap(),
3642                         SecretKey::from_slice(&[41; 32]).unwrap(),
3643                         SecretKey::from_slice(&[41; 32]).unwrap(),
3644                         [41; 32],
3645                         0,
3646                 );
3647
3648                 // Prune with one old state and a local commitment tx holding a few overlaps with the
3649                 // old state.
3650                 let mut monitor = ChannelMonitor::new(keys,
3651                         &PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[42; 32]).unwrap()), 0, &Script::new(),
3652                         (OutPoint { txid: Sha256dHash::from_slice(&[43; 32]).unwrap(), index: 0 }, Script::new()),
3653                         &PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[44; 32]).unwrap()),
3654                         &PublicKey::from_secret_key(&secp_ctx, &SecretKey::from_slice(&[45; 32]).unwrap()),
3655                         0, Script::new(), 46, 0, logger.clone());
3656
3657                 monitor.their_to_self_delay = Some(10);
3658
3659                 monitor.provide_latest_local_commitment_tx_info(LocalCommitmentTransaction::dummy(), dummy_keys!(), 0, preimages_to_local_htlcs!(preimages[0..10])).unwrap();
3660                 monitor.provide_latest_remote_commitment_tx_info(&dummy_tx, preimages_slice_to_htlc_outputs!(preimages[5..15]), 281474976710655, dummy_key);
3661                 monitor.provide_latest_remote_commitment_tx_info(&dummy_tx, preimages_slice_to_htlc_outputs!(preimages[15..20]), 281474976710654, dummy_key);
3662                 monitor.provide_latest_remote_commitment_tx_info(&dummy_tx, preimages_slice_to_htlc_outputs!(preimages[17..20]), 281474976710653, dummy_key);
3663                 monitor.provide_latest_remote_commitment_tx_info(&dummy_tx, preimages_slice_to_htlc_outputs!(preimages[18..20]), 281474976710652, dummy_key);
3664                 for &(ref preimage, ref hash) in preimages.iter() {
3665                         monitor.provide_payment_preimage(hash, preimage);
3666                 }
3667
3668                 // Now provide a secret, pruning preimages 10-15
3669                 let mut secret = [0; 32];
3670                 secret[0..32].clone_from_slice(&hex::decode("7cc854b54e3e0dcdb010d7a3fee464a9687be6e8db3be6854c475621e007a5dc").unwrap());
3671                 monitor.provide_secret(281474976710655, secret.clone()).unwrap();
3672                 assert_eq!(monitor.payment_preimages.len(), 15);
3673                 test_preimages_exist!(&preimages[0..10], monitor);
3674                 test_preimages_exist!(&preimages[15..20], monitor);
3675
3676                 // Now provide a further secret, pruning preimages 15-17
3677                 secret[0..32].clone_from_slice(&hex::decode("c7518c8ae4660ed02894df8976fa1a3659c1a8b4b5bec0c4b872abeba4cb8964").unwrap());
3678                 monitor.provide_secret(281474976710654, secret.clone()).unwrap();
3679                 assert_eq!(monitor.payment_preimages.len(), 13);
3680                 test_preimages_exist!(&preimages[0..10], monitor);
3681                 test_preimages_exist!(&preimages[17..20], monitor);
3682
3683                 // Now update local commitment tx info, pruning only element 18 as we still care about the
3684                 // previous commitment tx's preimages too
3685                 monitor.provide_latest_local_commitment_tx_info(LocalCommitmentTransaction::dummy(), dummy_keys!(), 0, preimages_to_local_htlcs!(preimages[0..5])).unwrap();
3686                 secret[0..32].clone_from_slice(&hex::decode("2273e227a5b7449b6e70f1fb4652864038b1cbf9cd7c043a7d6456b7fc275ad8").unwrap());
3687                 monitor.provide_secret(281474976710653, secret.clone()).unwrap();
3688                 assert_eq!(monitor.payment_preimages.len(), 12);
3689                 test_preimages_exist!(&preimages[0..10], monitor);
3690                 test_preimages_exist!(&preimages[18..20], monitor);
3691
3692                 // But if we do it again, we'll prune 5-10
3693                 monitor.provide_latest_local_commitment_tx_info(LocalCommitmentTransaction::dummy(), dummy_keys!(), 0, preimages_to_local_htlcs!(preimages[0..3])).unwrap();
3694                 secret[0..32].clone_from_slice(&hex::decode("27cddaa5624534cb6cb9d7da077cf2b22ab21e9b506fd4998a51d54502e99116").unwrap());
3695                 monitor.provide_secret(281474976710652, secret.clone()).unwrap();
3696                 assert_eq!(monitor.payment_preimages.len(), 5);
3697                 test_preimages_exist!(&preimages[0..5], monitor);
3698         }
3699
3700         #[test]
3701         fn test_claim_txn_weight_computation() {
3702                 // We test Claim txn weight, knowing that we want expected weigth and
3703                 // not actual case to avoid sigs and time-lock delays hell variances.
3704
3705                 let secp_ctx = Secp256k1::new();
3706                 let privkey = SecretKey::from_slice(&hex::decode("0101010101010101010101010101010101010101010101010101010101010101").unwrap()[..]).unwrap();
3707                 let pubkey = PublicKey::from_secret_key(&secp_ctx, &privkey);
3708                 let mut sum_actual_sigs = 0;
3709
3710                 macro_rules! sign_input {
3711                         ($sighash_parts: expr, $input: expr, $idx: expr, $amount: expr, $input_type: expr, $sum_actual_sigs: expr) => {
3712                                 let htlc = HTLCOutputInCommitment {
3713                                         offered: if *$input_type == InputDescriptors::RevokedOfferedHTLC || *$input_type == InputDescriptors::OfferedHTLC { true } else { false },
3714                                         amount_msat: 0,
3715                                         cltv_expiry: 2 << 16,
3716                                         payment_hash: PaymentHash([1; 32]),
3717                                         transaction_output_index: Some($idx),
3718                                 };
3719                                 let redeem_script = if *$input_type == InputDescriptors::RevokedOutput { chan_utils::get_revokeable_redeemscript(&pubkey, 256, &pubkey) } else { chan_utils::get_htlc_redeemscript_with_explicit_keys(&htlc, &pubkey, &pubkey, &pubkey) };
3720                                 let sighash = hash_to_message!(&$sighash_parts.sighash_all(&$input, &redeem_script, $amount)[..]);
3721                                 let sig = secp_ctx.sign(&sighash, &privkey);
3722                                 $input.witness.push(sig.serialize_der().to_vec());
3723                                 $input.witness[0].push(SigHashType::All as u8);
3724                                 sum_actual_sigs += $input.witness[0].len();
3725                                 if *$input_type == InputDescriptors::RevokedOutput {
3726                                         $input.witness.push(vec!(1));
3727                                 } else if *$input_type == InputDescriptors::RevokedOfferedHTLC || *$input_type == InputDescriptors::RevokedReceivedHTLC {
3728                                         $input.witness.push(pubkey.clone().serialize().to_vec());
3729                                 } else if *$input_type == InputDescriptors::ReceivedHTLC {
3730                                         $input.witness.push(vec![0]);
3731                                 } else {
3732                                         $input.witness.push(PaymentPreimage([1; 32]).0.to_vec());
3733                                 }
3734                                 $input.witness.push(redeem_script.into_bytes());
3735                                 println!("witness[0] {}", $input.witness[0].len());
3736                                 println!("witness[1] {}", $input.witness[1].len());
3737                                 println!("witness[2] {}", $input.witness[2].len());
3738                         }
3739                 }
3740
3741                 let script_pubkey = Builder::new().push_opcode(opcodes::all::OP_RETURN).into_script();
3742                 let txid = Sha256dHash::from_hex("56944c5d3f98413ef45cf54545538103cc9f298e0575820ad3591376e2e0f65d").unwrap();
3743
3744                 // Justice tx with 1 to_local, 2 revoked offered HTLCs, 1 revoked received HTLCs
3745                 let mut claim_tx = Transaction { version: 0, lock_time: 0, input: Vec::new(), output: Vec::new() };
3746                 for i in 0..4 {
3747                         claim_tx.input.push(TxIn {
3748                                 previous_output: BitcoinOutPoint {
3749                                         txid,
3750                                         vout: i,
3751                                 },
3752                                 script_sig: Script::new(),
3753                                 sequence: 0xfffffffd,
3754                                 witness: Vec::new(),
3755                         });
3756                 }
3757                 claim_tx.output.push(TxOut {
3758                         script_pubkey: script_pubkey.clone(),
3759                         value: 0,
3760                 });
3761                 let base_weight = claim_tx.get_weight();
3762                 let sighash_parts = bip143::SighashComponents::new(&claim_tx);
3763                 let inputs_des = vec![InputDescriptors::RevokedOutput, InputDescriptors::RevokedOfferedHTLC, InputDescriptors::RevokedOfferedHTLC, InputDescriptors::RevokedReceivedHTLC];
3764                 for (idx, inp) in claim_tx.input.iter_mut().zip(inputs_des.iter()).enumerate() {
3765                         sign_input!(sighash_parts, inp.0, idx as u32, 0, inp.1, sum_actual_sigs);
3766                 }
3767                 assert_eq!(base_weight + ChannelMonitor::<InMemoryChannelKeys>::get_witnesses_weight(&inputs_des[..]),  claim_tx.get_weight() + /* max_length_sig */ (73 * inputs_des.len() - sum_actual_sigs));
3768
3769                 // Claim tx with 1 offered HTLCs, 3 received HTLCs
3770                 claim_tx.input.clear();
3771                 sum_actual_sigs = 0;
3772                 for i in 0..4 {
3773                         claim_tx.input.push(TxIn {
3774                                 previous_output: BitcoinOutPoint {
3775                                         txid,
3776                                         vout: i,
3777                                 },
3778                                 script_sig: Script::new(),
3779                                 sequence: 0xfffffffd,
3780                                 witness: Vec::new(),
3781                         });
3782                 }
3783                 let base_weight = claim_tx.get_weight();
3784                 let sighash_parts = bip143::SighashComponents::new(&claim_tx);
3785                 let inputs_des = vec![InputDescriptors::OfferedHTLC, InputDescriptors::ReceivedHTLC, InputDescriptors::ReceivedHTLC, InputDescriptors::ReceivedHTLC];
3786                 for (idx, inp) in claim_tx.input.iter_mut().zip(inputs_des.iter()).enumerate() {
3787                         sign_input!(sighash_parts, inp.0, idx as u32, 0, inp.1, sum_actual_sigs);
3788                 }
3789                 assert_eq!(base_weight + ChannelMonitor::<InMemoryChannelKeys>::get_witnesses_weight(&inputs_des[..]),  claim_tx.get_weight() + /* max_length_sig */ (73 * inputs_des.len() - sum_actual_sigs));
3790
3791                 // Justice tx with 1 revoked HTLC-Success tx output
3792                 claim_tx.input.clear();
3793                 sum_actual_sigs = 0;
3794                 claim_tx.input.push(TxIn {
3795                         previous_output: BitcoinOutPoint {
3796                                 txid,
3797                                 vout: 0,
3798                         },
3799                         script_sig: Script::new(),
3800                         sequence: 0xfffffffd,
3801                         witness: Vec::new(),
3802                 });
3803                 let base_weight = claim_tx.get_weight();
3804                 let sighash_parts = bip143::SighashComponents::new(&claim_tx);
3805                 let inputs_des = vec![InputDescriptors::RevokedOutput];
3806                 for (idx, inp) in claim_tx.input.iter_mut().zip(inputs_des.iter()).enumerate() {
3807                         sign_input!(sighash_parts, inp.0, idx as u32, 0, inp.1, sum_actual_sigs);
3808                 }
3809                 assert_eq!(base_weight + ChannelMonitor::<InMemoryChannelKeys>::get_witnesses_weight(&inputs_des[..]), claim_tx.get_weight() + /* max_length_isg */ (73 * inputs_des.len() - sum_actual_sigs));
3810         }
3811
3812         // Further testing is done in the ChannelManager integration tests.
3813 }