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