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