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