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